OpenTTD Source: src/network/core/tcp_admin.h Source File

OpenTTD Source 15.0-beta1

tcp_admin.h
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
12#ifndef NETWORK_CORE_TCP_ADMIN_H
13#define NETWORK_CORE_TCP_ADMIN_H
14
15#include "os_abstraction.h"
16#include "tcp.h"
17#include "../network_type.h"
18#include "../../core/pool_type.hpp"
19
24 enum PacketAdminType : uint8_t {
25 ADMIN_PACKET_ADMIN_JOIN,
26 ADMIN_PACKET_ADMIN_QUIT,
27 ADMIN_PACKET_ADMIN_UPDATE_FREQUENCY,
28 ADMIN_PACKET_ADMIN_POLL,
29 ADMIN_PACKET_ADMIN_CHAT,
30 ADMIN_PACKET_ADMIN_RCON,
31 ADMIN_PACKET_ADMIN_GAMESCRIPT,
32 ADMIN_PACKET_ADMIN_PING,
33 ADMIN_PACKET_ADMIN_EXTERNAL_CHAT,
34 ADMIN_PACKET_ADMIN_JOIN_SECURE,
35 ADMIN_PACKET_ADMIN_AUTH_RESPONSE,
36
37 ADMIN_PACKET_SERVER_FULL = 100,
38 ADMIN_PACKET_SERVER_BANNED,
39 ADMIN_PACKET_SERVER_ERROR,
40 ADMIN_PACKET_SERVER_PROTOCOL,
41 ADMIN_PACKET_SERVER_WELCOME,
42 ADMIN_PACKET_SERVER_NEWGAME,
43 ADMIN_PACKET_SERVER_SHUTDOWN,
44
45 ADMIN_PACKET_SERVER_DATE,
46 ADMIN_PACKET_SERVER_CLIENT_JOIN,
47 ADMIN_PACKET_SERVER_CLIENT_INFO,
48 ADMIN_PACKET_SERVER_CLIENT_UPDATE,
49 ADMIN_PACKET_SERVER_CLIENT_QUIT,
50 ADMIN_PACKET_SERVER_CLIENT_ERROR,
51 ADMIN_PACKET_SERVER_COMPANY_NEW,
52 ADMIN_PACKET_SERVER_COMPANY_INFO,
53 ADMIN_PACKET_SERVER_COMPANY_UPDATE,
54 ADMIN_PACKET_SERVER_COMPANY_REMOVE,
55 ADMIN_PACKET_SERVER_COMPANY_ECONOMY,
56 ADMIN_PACKET_SERVER_COMPANY_STATS,
57 ADMIN_PACKET_SERVER_CHAT,
58 ADMIN_PACKET_SERVER_RCON,
59 ADMIN_PACKET_SERVER_CONSOLE,
60 ADMIN_PACKET_SERVER_CMD_NAMES,
61 ADMIN_PACKET_SERVER_CMD_LOGGING_OLD,
62 ADMIN_PACKET_SERVER_GAMESCRIPT,
63 ADMIN_PACKET_SERVER_RCON_END,
64 ADMIN_PACKET_SERVER_PONG,
65 ADMIN_PACKET_SERVER_CMD_LOGGING,
66 ADMIN_PACKET_SERVER_AUTH_REQUEST,
67 ADMIN_PACKET_SERVER_ENABLE_ENCRYPTION,
68
69 INVALID_ADMIN_PACKET = 0xFF,
70};
71
73 enum AdminStatus {
74 ADMIN_STATUS_INACTIVE,
75 ADMIN_STATUS_AUTHENTICATE,
76 ADMIN_STATUS_ACTIVE,
77 ADMIN_STATUS_END,
78};
79
81 enum AdminUpdateType {
82 ADMIN_UPDATE_DATE,
83 ADMIN_UPDATE_CLIENT_INFO,
84 ADMIN_UPDATE_COMPANY_INFO,
85 ADMIN_UPDATE_COMPANY_ECONOMY,
86 ADMIN_UPDATE_COMPANY_STATS,
87 ADMIN_UPDATE_CHAT,
88 ADMIN_UPDATE_CONSOLE,
89 ADMIN_UPDATE_CMD_NAMES,
90 ADMIN_UPDATE_CMD_LOGGING,
91 ADMIN_UPDATE_GAMESCRIPT,
92 ADMIN_UPDATE_END,
93};
94
96 enum AdminUpdateFrequency {
97 ADMIN_FREQUENCY_POLL = 0x01,
98 ADMIN_FREQUENCY_DAILY = 0x02,
99 ADMIN_FREQUENCY_WEEKLY = 0x04,
100 ADMIN_FREQUENCY_MONTHLY = 0x08,
101 ADMIN_FREQUENCY_QUARTERLY = 0x10,
102 ADMIN_FREQUENCY_ANUALLY = 0x20,
103 ADMIN_FREQUENCY_AUTOMATIC = 0x40,
104};
105 DECLARE_ENUM_AS_BIT_SET(AdminUpdateFrequency)
106
107
108enum AdminCompanyRemoveReason {
109 ADMIN_CRR_MANUAL,
110 ADMIN_CRR_AUTOCLEAN,
111 ADMIN_CRR_BANKRUPT,
112
113 ADMIN_CRR_END,
114};
115
117 class NetworkAdminSocketHandler : public NetworkTCPSocketHandler {
118protected:
119 std::string admin_name;
120 std::string admin_version;
121 AdminStatus status;
122
123 NetworkRecvStatus ReceiveInvalidPacket(PacketAdminType type);
124
133 virtual NetworkRecvStatus Receive_ADMIN_JOIN(Packet &p);
134
140 virtual NetworkRecvStatus Receive_ADMIN_QUIT(Packet &p);
141
149 virtual NetworkRecvStatus Receive_ADMIN_UPDATE_FREQUENCY(Packet &p);
150
160 virtual NetworkRecvStatus Receive_ADMIN_POLL(Packet &p);
161
171 virtual NetworkRecvStatus Receive_ADMIN_CHAT(Packet &p);
172
182 virtual NetworkRecvStatus Receive_ADMIN_EXTERNAL_CHAT(Packet &p);
183
190 virtual NetworkRecvStatus Receive_ADMIN_RCON(Packet &p);
191
198 virtual NetworkRecvStatus Receive_ADMIN_GAMESCRIPT(Packet &p);
199
206 virtual NetworkRecvStatus Receive_ADMIN_PING(Packet &p);
207
220 virtual NetworkRecvStatus Receive_ADMIN_JOIN_SECURE(Packet &p);
221
232 virtual NetworkRecvStatus Receive_ADMIN_AUTH_RESPONSE(Packet &p);
233
239 virtual NetworkRecvStatus Receive_SERVER_FULL(Packet &p);
240
246 virtual NetworkRecvStatus Receive_SERVER_BANNED(Packet &p);
247
254 virtual NetworkRecvStatus Receive_SERVER_ERROR(Packet &p);
255
265 virtual NetworkRecvStatus Receive_SERVER_PROTOCOL(Packet &p);
266
281 virtual NetworkRecvStatus Receive_SERVER_WELCOME(Packet &p);
282
288 virtual NetworkRecvStatus Receive_SERVER_NEWGAME(Packet &p);
289
295 virtual NetworkRecvStatus Receive_SERVER_SHUTDOWN(Packet &p);
296
303 virtual NetworkRecvStatus Receive_SERVER_DATE(Packet &p);
304
311 virtual NetworkRecvStatus Receive_SERVER_CLIENT_JOIN(Packet &p);
312
324 virtual NetworkRecvStatus Receive_SERVER_CLIENT_INFO(Packet &p);
325
334 virtual NetworkRecvStatus Receive_SERVER_CLIENT_UPDATE(Packet &p);
335
342 virtual NetworkRecvStatus Receive_SERVER_CLIENT_QUIT(Packet &p);
343
351 virtual NetworkRecvStatus Receive_SERVER_CLIENT_ERROR(Packet &p);
352
359 virtual NetworkRecvStatus Receive_SERVER_COMPANY_NEW(Packet &p);
360
373 virtual NetworkRecvStatus Receive_SERVER_COMPANY_INFO(Packet &p);
374
390 virtual NetworkRecvStatus Receive_SERVER_COMPANY_UPDATE(Packet &p);
391
399 virtual NetworkRecvStatus Receive_SERVER_COMPANY_REMOVE(Packet &p);
400
417 virtual NetworkRecvStatus Receive_SERVER_COMPANY_ECONOMY(Packet &p);
418
435 virtual NetworkRecvStatus Receive_SERVER_COMPANY_STATS(Packet &p);
436
447 virtual NetworkRecvStatus Receive_SERVER_CHAT(Packet &p);
448
456 virtual NetworkRecvStatus Receive_SERVER_RCON(Packet &p);
457
465 virtual NetworkRecvStatus Receive_SERVER_CONSOLE(Packet &p);
466
484 virtual NetworkRecvStatus Receive_SERVER_CMD_NAMES(Packet &p);
485
504 virtual NetworkRecvStatus Receive_SERVER_CMD_LOGGING(Packet &p);
505
515 virtual NetworkRecvStatus Receive_SERVER_AUTH_REQUEST(Packet &p);
516
523 virtual NetworkRecvStatus Receive_SERVER_ENABLE_ENCRYPTION(Packet &p);
524
531 virtual NetworkRecvStatus Receive_SERVER_PONG(Packet &p);
532
539 virtual NetworkRecvStatus Receive_SERVER_RCON_END(Packet &p);
540
541 NetworkRecvStatus HandlePacket(Packet &p);
542public:
543 NetworkRecvStatus CloseConnection(bool error = true) override;
544
545 NetworkAdminSocketHandler(SOCKET s);
546
547 NetworkRecvStatus ReceivePackets();
548
553 AdminStatus GetAdminStatus() const
554 {
555 return this->status;
556 }
557};
558
559#endif /* NETWORK_CORE_TCP_ADMIN_H */
NetworkAdminSocketHandler
Main socket handler for admin related connections.
Definition tcp_admin.h:117
NetworkAdminSocketHandler::Receive_ADMIN_EXTERNAL_CHAT
virtual NetworkRecvStatus Receive_ADMIN_EXTERNAL_CHAT(Packet &p)
Send chat from the external source: string Name of the source this message came from.
Definition tcp_admin.cpp:140
NetworkAdminSocketHandler::Receive_ADMIN_RCON
virtual NetworkRecvStatus Receive_ADMIN_RCON(Packet &p)
Execute a command on the servers console: string Command to be executed.
Definition tcp_admin.cpp:141
NetworkAdminSocketHandler::Receive_SERVER_AUTH_REQUEST
virtual NetworkRecvStatus Receive_SERVER_AUTH_REQUEST(Packet &p)
Server requests authentication challenge from the admin.
Definition tcp_admin.cpp:174
NetworkAdminSocketHandler::Receive_SERVER_CLIENT_ERROR
virtual NetworkRecvStatus Receive_SERVER_CLIENT_ERROR(Packet &p)
Notification about a client error (and thus the clients disconnection).
Definition tcp_admin.cpp:160
NetworkAdminSocketHandler::Receive_SERVER_WELCOME
virtual NetworkRecvStatus Receive_SERVER_WELCOME(Packet &p)
Welcome a connected admin to the game: string Name of the Server.
Definition tcp_admin.cpp:151
NetworkAdminSocketHandler::Receive_SERVER_COMPANY_ECONOMY
virtual NetworkRecvStatus Receive_SERVER_COMPANY_ECONOMY(Packet &p)
Economy update of a specific company: uint8_t ID of the company.
Definition tcp_admin.cpp:165
NetworkAdminSocketHandler::Receive_SERVER_COMPANY_STATS
virtual NetworkRecvStatus Receive_SERVER_COMPANY_STATS(Packet &p)
Company statistics on stations and vehicles: uint8_t ID of the company.
Definition tcp_admin.cpp:166
NetworkAdminSocketHandler::Receive_SERVER_COMPANY_NEW
virtual NetworkRecvStatus Receive_SERVER_COMPANY_NEW(Packet &p)
Notification of a new company: uint8_t ID of the new company.
Definition tcp_admin.cpp:161
NetworkAdminSocketHandler::Receive_SERVER_DATE
virtual NetworkRecvStatus Receive_SERVER_DATE(Packet &p)
Send the current date of the game: uint32_t Current game date.
Definition tcp_admin.cpp:155
NetworkAdminSocketHandler::Receive_SERVER_COMPANY_UPDATE
virtual NetworkRecvStatus Receive_SERVER_COMPANY_UPDATE(Packet &p)
Company information of a specific company: uint8_t ID of the company.
Definition tcp_admin.cpp:163
NetworkAdminSocketHandler::Receive_SERVER_RCON
virtual NetworkRecvStatus Receive_SERVER_RCON(Packet &p)
Result of an rcon command: uint16_t Colour as it would be used on the server or a client.
Definition tcp_admin.cpp:168
NetworkAdminSocketHandler::HandlePacket
NetworkRecvStatus HandlePacket(Packet &p)
Handle the given packet, i.e.
Definition tcp_admin.cpp:46
NetworkAdminSocketHandler::Receive_ADMIN_GAMESCRIPT
virtual NetworkRecvStatus Receive_ADMIN_GAMESCRIPT(Packet &p)
Send a JSON string to the current active GameScript.
Definition tcp_admin.cpp:142
NetworkAdminSocketHandler::Receive_SERVER_CMD_LOGGING
virtual NetworkRecvStatus Receive_SERVER_CMD_LOGGING(Packet &p)
Send incoming command packets to the admin network.
Definition tcp_admin.cpp:171
NetworkAdminSocketHandler::Receive_SERVER_SHUTDOWN
virtual NetworkRecvStatus Receive_SERVER_SHUTDOWN(Packet &p)
Notification about the server shutting down.
Definition tcp_admin.cpp:153
NetworkAdminSocketHandler::Receive_SERVER_ERROR
virtual NetworkRecvStatus Receive_SERVER_ERROR(Packet &p)
An error was caused by this admin connection (connection gets closed).
Definition tcp_admin.cpp:149
NetworkAdminSocketHandler::CloseConnection
NetworkRecvStatus CloseConnection(bool error=true) override
This will put this socket handler in a close state.
Definition tcp_admin.cpp:35
NetworkAdminSocketHandler::Receive_SERVER_COMPANY_REMOVE
virtual NetworkRecvStatus Receive_SERVER_COMPANY_REMOVE(Packet &p)
Notification about a removed company (e.g.
Definition tcp_admin.cpp:164
NetworkAdminSocketHandler::Receive_SERVER_CLIENT_UPDATE
virtual NetworkRecvStatus Receive_SERVER_CLIENT_UPDATE(Packet &p)
Client update details on a specific client (e.g.
Definition tcp_admin.cpp:158
NetworkAdminSocketHandler::Receive_SERVER_FULL
virtual NetworkRecvStatus Receive_SERVER_FULL(Packet &p)
The server is full (connection gets closed).
Definition tcp_admin.cpp:147
NetworkAdminSocketHandler::Receive_ADMIN_QUIT
virtual NetworkRecvStatus Receive_ADMIN_QUIT(Packet &p)
Notification to the server that this admin is quitting.
Definition tcp_admin.cpp:136
NetworkAdminSocketHandler::Receive_SERVER_CLIENT_JOIN
virtual NetworkRecvStatus Receive_SERVER_CLIENT_JOIN(Packet &p)
Notification of a new client: uint32_t ID of the new client.
Definition tcp_admin.cpp:156
NetworkAdminSocketHandler::Receive_ADMIN_AUTH_RESPONSE
virtual NetworkRecvStatus Receive_ADMIN_AUTH_RESPONSE(Packet &p)
Admin responds to ADMIN_PACKET_SERVER_AUTH_REQUEST with the appropriate data given the agreed upon Ne...
Definition tcp_admin.cpp:145
NetworkAdminSocketHandler::Receive_SERVER_CLIENT_QUIT
virtual NetworkRecvStatus Receive_SERVER_CLIENT_QUIT(Packet &p)
Notification about a client leaving the game.
Definition tcp_admin.cpp:159
NetworkAdminSocketHandler::GetAdminStatus
AdminStatus GetAdminStatus() const
Get the status of the admin.
Definition tcp_admin.h:553
NetworkAdminSocketHandler::Receive_ADMIN_POLL
virtual NetworkRecvStatus Receive_ADMIN_POLL(Packet &p)
Poll the server for certain updates, an invalid poll (e.g.
Definition tcp_admin.cpp:138
NetworkAdminSocketHandler::Receive_ADMIN_JOIN
virtual NetworkRecvStatus Receive_ADMIN_JOIN(Packet &p)
Join the admin network using an unsecured password exchange: string Unsecured password the server is ...
Definition tcp_admin.cpp:135
NetworkAdminSocketHandler::Receive_ADMIN_PING
virtual NetworkRecvStatus Receive_ADMIN_PING(Packet &p)
Ping the server, requiring the server to reply with a pong packet.
Definition tcp_admin.cpp:143
NetworkAdminSocketHandler::Receive_ADMIN_CHAT
virtual NetworkRecvStatus Receive_ADMIN_CHAT(Packet &p)
Send chat as the server: uint8_t Action such as NETWORK_ACTION_CHAT_CLIENT (see NetworkAction).
Definition tcp_admin.cpp:139
NetworkAdminSocketHandler::Receive_SERVER_CONSOLE
virtual NetworkRecvStatus Receive_SERVER_CONSOLE(Packet &p)
Send what would be printed on the server's console also into the admin network.
Definition tcp_admin.cpp:169
NetworkAdminSocketHandler::Receive_SERVER_COMPANY_INFO
virtual NetworkRecvStatus Receive_SERVER_COMPANY_INFO(Packet &p)
Company information on a specific company: uint8_t ID of the company.
Definition tcp_admin.cpp:162
NetworkAdminSocketHandler::Receive_SERVER_PONG
virtual NetworkRecvStatus Receive_SERVER_PONG(Packet &p)
Send a ping-reply (pong) to the admin that sent us the ping packet.
Definition tcp_admin.cpp:173
NetworkAdminSocketHandler::Receive_SERVER_ENABLE_ENCRYPTION
virtual NetworkRecvStatus Receive_SERVER_ENABLE_ENCRYPTION(Packet &p)
Indication to the client that authentication is complete and encryption has to be used from here on f...
Definition tcp_admin.cpp:175
NetworkAdminSocketHandler::Receive_ADMIN_JOIN_SECURE
virtual NetworkRecvStatus Receive_ADMIN_JOIN_SECURE(Packet &p)
Join the admin network using a secure authentication method: string Name of the application being use...
Definition tcp_admin.cpp:144
NetworkAdminSocketHandler::ReceiveInvalidPacket
NetworkRecvStatus ReceiveInvalidPacket(PacketAdminType type)
Helper for logging receiving invalid packets.
Definition tcp_admin.cpp:129
NetworkAdminSocketHandler::ReceivePackets
NetworkRecvStatus ReceivePackets()
Do the actual receiving of packets.
Definition tcp_admin.cpp:113
NetworkAdminSocketHandler::Receive_SERVER_CMD_NAMES
virtual NetworkRecvStatus Receive_SERVER_CMD_NAMES(Packet &p)
Send DoCommand names to the bot upon request only.
Definition tcp_admin.cpp:170
NetworkAdminSocketHandler::status
AdminStatus status
Status of this admin.
Definition tcp_admin.h:121
NetworkAdminSocketHandler::Receive_SERVER_NEWGAME
virtual NetworkRecvStatus Receive_SERVER_NEWGAME(Packet &p)
Notification about a newgame.
Definition tcp_admin.cpp:152
NetworkAdminSocketHandler::admin_version
std::string admin_version
Version string of the admin.
Definition tcp_admin.h:120
NetworkAdminSocketHandler::Receive_ADMIN_UPDATE_FREQUENCY
virtual NetworkRecvStatus Receive_ADMIN_UPDATE_FREQUENCY(Packet &p)
Register updates to be sent at certain frequencies (as announced in the PROTOCOL packet): uint16_t Up...
Definition tcp_admin.cpp:137
NetworkAdminSocketHandler::Receive_SERVER_PROTOCOL
virtual NetworkRecvStatus Receive_SERVER_PROTOCOL(Packet &p)
Inform a just joined admin about the protocol specifics: uint8_t Protocol version.
Definition tcp_admin.cpp:150
NetworkAdminSocketHandler::Receive_SERVER_RCON_END
virtual NetworkRecvStatus Receive_SERVER_RCON_END(Packet &p)
Notify the admin connection that the rcon command has finished.
Definition tcp_admin.cpp:172
NetworkAdminSocketHandler::Receive_SERVER_CHAT
virtual NetworkRecvStatus Receive_SERVER_CHAT(Packet &p)
Send chat from the game into the admin network: uint8_t Action such as NETWORK_ACTION_CHAT_CLIENT (se...
Definition tcp_admin.cpp:167
NetworkAdminSocketHandler::Receive_SERVER_CLIENT_INFO
virtual NetworkRecvStatus Receive_SERVER_CLIENT_INFO(Packet &p)
Client information of a specific client: uint32_t ID of the client.
Definition tcp_admin.cpp:157
NetworkAdminSocketHandler::admin_name
std::string admin_name
Name of the admin.
Definition tcp_admin.h:119
NetworkAdminSocketHandler::Receive_SERVER_BANNED
virtual NetworkRecvStatus Receive_SERVER_BANNED(Packet &p)
The source IP address is banned (connection gets closed).
Definition tcp_admin.cpp:148
NetworkTCPSocketHandler
Base socket handler for all TCP sockets.
Definition tcp.h:31
NetworkRecvStatus
NetworkRecvStatus
Status of a network client; reasons why a client has quit.
Definition core.h:23
DECLARE_ENUM_AS_BIT_SET
#define DECLARE_ENUM_AS_BIT_SET(enum_type)
Operators to allow to work with enum as with type safe bit set in C++.
Definition enum_type.hpp:35
os_abstraction.h
Network stuff has many things that needs to be included and/or implemented by default.
Packet
Internal entity of a packet.
Definition packet.h:42
tcp.h
Basic functions to receive and send TCP packets.
PacketAdminType
PacketAdminType
Enum with types of TCP packets specific to the admin network.
Definition tcp_admin.h:24
ADMIN_PACKET_ADMIN_PING
@ ADMIN_PACKET_ADMIN_PING
The admin sends a ping to the server, expecting a ping-reply (PONG) packet.
Definition tcp_admin.h:32
ADMIN_PACKET_SERVER_CONSOLE
@ ADMIN_PACKET_SERVER_CONSOLE
The server gives the admin the data that got printed to its console.
Definition tcp_admin.h:59
ADMIN_PACKET_SERVER_ENABLE_ENCRYPTION
@ ADMIN_PACKET_SERVER_ENABLE_ENCRYPTION
The server tells that authentication has completed and requests to enable encryption with the keys of...
Definition tcp_admin.h:67
ADMIN_PACKET_ADMIN_UPDATE_FREQUENCY
@ ADMIN_PACKET_ADMIN_UPDATE_FREQUENCY
The admin tells the server the update frequency of a particular piece of information.
Definition tcp_admin.h:27
ADMIN_PACKET_SERVER_CLIENT_UPDATE
@ ADMIN_PACKET_SERVER_CLIENT_UPDATE
The server gives the admin an information update on a client.
Definition tcp_admin.h:48
ADMIN_PACKET_SERVER_COMPANY_STATS
@ ADMIN_PACKET_SERVER_COMPANY_STATS
The server gives the admin some statistics about a company.
Definition tcp_admin.h:56
ADMIN_PACKET_SERVER_COMPANY_ECONOMY
@ ADMIN_PACKET_SERVER_COMPANY_ECONOMY
The server gives the admin some economy related company information.
Definition tcp_admin.h:55
ADMIN_PACKET_SERVER_GAMESCRIPT
@ ADMIN_PACKET_SERVER_GAMESCRIPT
The server gives the admin information from the GameScript in JSON.
Definition tcp_admin.h:62
ADMIN_PACKET_ADMIN_JOIN
@ ADMIN_PACKET_ADMIN_JOIN
The admin announces and authenticates itself to the server using an unsecured passwords.
Definition tcp_admin.h:25
ADMIN_PACKET_SERVER_CMD_LOGGING_OLD
@ ADMIN_PACKET_SERVER_CMD_LOGGING_OLD
Used to be the type ID of ADMIN_PACKET_SERVER_CMD_LOGGING in NETWORK_GAME_ADMIN_VERSION 1.
Definition tcp_admin.h:61
ADMIN_PACKET_SERVER_CLIENT_INFO
@ ADMIN_PACKET_SERVER_CLIENT_INFO
The server gives the admin information about a client.
Definition tcp_admin.h:47
ADMIN_PACKET_SERVER_CLIENT_ERROR
@ ADMIN_PACKET_SERVER_CLIENT_ERROR
The server tells the admin that a client caused an error.
Definition tcp_admin.h:50
ADMIN_PACKET_ADMIN_GAMESCRIPT
@ ADMIN_PACKET_ADMIN_GAMESCRIPT
The admin sends a JSON string for the GameScript.
Definition tcp_admin.h:31
ADMIN_PACKET_SERVER_AUTH_REQUEST
@ ADMIN_PACKET_SERVER_AUTH_REQUEST
The server gives the admin the used authentication method and required parameters.
Definition tcp_admin.h:66
ADMIN_PACKET_SERVER_CHAT
@ ADMIN_PACKET_SERVER_CHAT
The server received a chat message and relays it.
Definition tcp_admin.h:57
ADMIN_PACKET_SERVER_SHUTDOWN
@ ADMIN_PACKET_SERVER_SHUTDOWN
The server tells the admin its shutting down.
Definition tcp_admin.h:43
ADMIN_PACKET_SERVER_RCON_END
@ ADMIN_PACKET_SERVER_RCON_END
The server indicates that the remote console command has completed.
Definition tcp_admin.h:63
ADMIN_PACKET_SERVER_WELCOME
@ ADMIN_PACKET_SERVER_WELCOME
The server welcomes the admin to a game.
Definition tcp_admin.h:41
ADMIN_PACKET_SERVER_COMPANY_REMOVE
@ ADMIN_PACKET_SERVER_COMPANY_REMOVE
The server tells the admin that a company was removed.
Definition tcp_admin.h:54
ADMIN_PACKET_SERVER_ERROR
@ ADMIN_PACKET_SERVER_ERROR
The server tells the admin an error has occurred.
Definition tcp_admin.h:39
ADMIN_PACKET_ADMIN_QUIT
@ ADMIN_PACKET_ADMIN_QUIT
The admin tells the server that it is quitting.
Definition tcp_admin.h:26
ADMIN_PACKET_ADMIN_POLL
@ ADMIN_PACKET_ADMIN_POLL
The admin explicitly polls for a piece of information.
Definition tcp_admin.h:28
ADMIN_PACKET_SERVER_NEWGAME
@ ADMIN_PACKET_SERVER_NEWGAME
The server tells the admin its going to start a new game.
Definition tcp_admin.h:42
ADMIN_PACKET_SERVER_BANNED
@ ADMIN_PACKET_SERVER_BANNED
The server tells the admin it is banned.
Definition tcp_admin.h:38
ADMIN_PACKET_SERVER_COMPANY_UPDATE
@ ADMIN_PACKET_SERVER_COMPANY_UPDATE
The server gives the admin an information update on a company.
Definition tcp_admin.h:53
ADMIN_PACKET_SERVER_PONG
@ ADMIN_PACKET_SERVER_PONG
The server replies to a ping request from the admin.
Definition tcp_admin.h:64
ADMIN_PACKET_SERVER_CLIENT_JOIN
@ ADMIN_PACKET_SERVER_CLIENT_JOIN
The server tells the admin that a client has joined.
Definition tcp_admin.h:46
ADMIN_PACKET_ADMIN_CHAT
@ ADMIN_PACKET_ADMIN_CHAT
The admin sends a chat message to be distributed.
Definition tcp_admin.h:29
ADMIN_PACKET_SERVER_CMD_LOGGING
@ ADMIN_PACKET_SERVER_CMD_LOGGING
The server gives the admin copies of incoming command packets.
Definition tcp_admin.h:65
ADMIN_PACKET_SERVER_PROTOCOL
@ ADMIN_PACKET_SERVER_PROTOCOL
The server tells the admin its protocol version.
Definition tcp_admin.h:40
ADMIN_PACKET_ADMIN_JOIN_SECURE
@ ADMIN_PACKET_ADMIN_JOIN_SECURE
The admin announces and starts a secure authentication handshake.
Definition tcp_admin.h:34
ADMIN_PACKET_SERVER_CLIENT_QUIT
@ ADMIN_PACKET_SERVER_CLIENT_QUIT
The server tells the admin that a client quit.
Definition tcp_admin.h:49
INVALID_ADMIN_PACKET
@ INVALID_ADMIN_PACKET
An invalid marker for admin packets.
Definition tcp_admin.h:69
ADMIN_PACKET_SERVER_COMPANY_INFO
@ ADMIN_PACKET_SERVER_COMPANY_INFO
The server gives the admin information about a company.
Definition tcp_admin.h:52
ADMIN_PACKET_SERVER_CMD_NAMES
@ ADMIN_PACKET_SERVER_CMD_NAMES
The server sends out the names of the DoCommands to the admins.
Definition tcp_admin.h:60
ADMIN_PACKET_SERVER_FULL
@ ADMIN_PACKET_SERVER_FULL
The server tells the admin it cannot accept the admin.
Definition tcp_admin.h:37
ADMIN_PACKET_ADMIN_RCON
@ ADMIN_PACKET_ADMIN_RCON
The admin sends a remote console command.
Definition tcp_admin.h:30
ADMIN_PACKET_ADMIN_AUTH_RESPONSE
@ ADMIN_PACKET_ADMIN_AUTH_RESPONSE
The admin responds to the authentication request.
Definition tcp_admin.h:35
ADMIN_PACKET_SERVER_DATE
@ ADMIN_PACKET_SERVER_DATE
The server tells the admin what the current game date is.
Definition tcp_admin.h:45
ADMIN_PACKET_SERVER_COMPANY_NEW
@ ADMIN_PACKET_SERVER_COMPANY_NEW
The server tells the admin that a new company has started.
Definition tcp_admin.h:51
ADMIN_PACKET_ADMIN_EXTERNAL_CHAT
@ ADMIN_PACKET_ADMIN_EXTERNAL_CHAT
The admin sends a chat message from external source.
Definition tcp_admin.h:33
ADMIN_PACKET_SERVER_RCON
@ ADMIN_PACKET_SERVER_RCON
The server's reply to a remove console command.
Definition tcp_admin.h:58
AdminCompanyRemoveReason
AdminCompanyRemoveReason
Reasons for removing a company - communicated to admins.
Definition tcp_admin.h:108
ADMIN_CRR_BANKRUPT
@ ADMIN_CRR_BANKRUPT
The company went belly-up.
Definition tcp_admin.h:111
ADMIN_CRR_MANUAL
@ ADMIN_CRR_MANUAL
The company is manually removed.
Definition tcp_admin.h:109
ADMIN_CRR_AUTOCLEAN
@ ADMIN_CRR_AUTOCLEAN
The company is removed due to autoclean.
Definition tcp_admin.h:110
ADMIN_CRR_END
@ ADMIN_CRR_END
Sentinel for end.
Definition tcp_admin.h:113
AdminUpdateFrequency
AdminUpdateFrequency
Update frequencies an admin can register.
Definition tcp_admin.h:96
ADMIN_FREQUENCY_MONTHLY
@ ADMIN_FREQUENCY_MONTHLY
The admin gets information about this on a monthly basis.
Definition tcp_admin.h:100
ADMIN_FREQUENCY_QUARTERLY
@ ADMIN_FREQUENCY_QUARTERLY
The admin gets information about this on a quarterly basis.
Definition tcp_admin.h:101
ADMIN_FREQUENCY_AUTOMATIC
@ ADMIN_FREQUENCY_AUTOMATIC
The admin gets information about this when it changes.
Definition tcp_admin.h:103
ADMIN_FREQUENCY_ANUALLY
@ ADMIN_FREQUENCY_ANUALLY
The admin gets information about this on a yearly basis.
Definition tcp_admin.h:102
ADMIN_FREQUENCY_WEEKLY
@ ADMIN_FREQUENCY_WEEKLY
The admin gets information about this on a weekly basis.
Definition tcp_admin.h:99
ADMIN_FREQUENCY_DAILY
@ ADMIN_FREQUENCY_DAILY
The admin gets information about this on a daily basis.
Definition tcp_admin.h:98
ADMIN_FREQUENCY_POLL
@ ADMIN_FREQUENCY_POLL
The admin can poll this.
Definition tcp_admin.h:97
AdminUpdateType
AdminUpdateType
Update types an admin can register a frequency for.
Definition tcp_admin.h:81
ADMIN_UPDATE_DATE
@ ADMIN_UPDATE_DATE
Updates about the date of the game.
Definition tcp_admin.h:82
ADMIN_UPDATE_GAMESCRIPT
@ ADMIN_UPDATE_GAMESCRIPT
The admin would like to have gamescript messages.
Definition tcp_admin.h:91
ADMIN_UPDATE_COMPANY_INFO
@ ADMIN_UPDATE_COMPANY_INFO
Updates about the generic information of companies.
Definition tcp_admin.h:84
ADMIN_UPDATE_CONSOLE
@ ADMIN_UPDATE_CONSOLE
The admin would like to have console messages.
Definition tcp_admin.h:88
ADMIN_UPDATE_CHAT
@ ADMIN_UPDATE_CHAT
The admin would like to have chat messages.
Definition tcp_admin.h:87
ADMIN_UPDATE_COMPANY_STATS
@ ADMIN_UPDATE_COMPANY_STATS
Updates about the statistics of companies.
Definition tcp_admin.h:86
ADMIN_UPDATE_COMPANY_ECONOMY
@ ADMIN_UPDATE_COMPANY_ECONOMY
Updates about the economy of companies.
Definition tcp_admin.h:85
ADMIN_UPDATE_END
@ ADMIN_UPDATE_END
Must ALWAYS be on the end of this list!! (period)
Definition tcp_admin.h:92
ADMIN_UPDATE_CLIENT_INFO
@ ADMIN_UPDATE_CLIENT_INFO
Updates about the information of clients.
Definition tcp_admin.h:83
ADMIN_UPDATE_CMD_NAMES
@ ADMIN_UPDATE_CMD_NAMES
The admin would like a list of all DoCommand names.
Definition tcp_admin.h:89
ADMIN_UPDATE_CMD_LOGGING
@ ADMIN_UPDATE_CMD_LOGGING
The admin would like to have DoCommand information.
Definition tcp_admin.h:90
AdminStatus
AdminStatus
Status of an admin.
Definition tcp_admin.h:73
ADMIN_STATUS_END
@ ADMIN_STATUS_END
Must ALWAYS be on the end of this list!! (period)
Definition tcp_admin.h:77
ADMIN_STATUS_INACTIVE
@ ADMIN_STATUS_INACTIVE
The admin is not connected nor active.
Definition tcp_admin.h:74
ADMIN_STATUS_ACTIVE
@ ADMIN_STATUS_ACTIVE
The admin is active.
Definition tcp_admin.h:76
ADMIN_STATUS_AUTHENTICATE
@ ADMIN_STATUS_AUTHENTICATE
The admin is connected and working on authentication.
Definition tcp_admin.h:75