OpenTTD Source
1.11.0-beta2
|
Go to the documentation of this file.
10 #ifndef NETWORK_ADMIN_H
11 #define NETWORK_ADMIN_H
NetworkRecvStatus SendGameScript(const char *json)
Send GameScript JSON output.
DestType
Destination of our chat messages.
NetworkRecvStatus Receive_ADMIN_UPDATE_FREQUENCY(Packet *p) override
Register updates to be sent at certain frequencies (as announced in the PROTOCOL packet): uint16 Upda...
NetworkRecvStatus SendConsole(const char *origin, const char *command)
Send console output of other clients.
static Titem * Get(size_t index)
Returns Titem with given index.
void NetworkServerSendAdminRcon(AdminIndex admin_index, TextColour colour_code, const char *string)
Pass the rcon reply to the admin.
void NetworkAdminClientInfo(const NetworkClientSocket *cs, bool new_client=false)
Notify the admin network of a new client (if they did opt in for the respective update).
NetworkRecvStatus SendError(NetworkErrorCode error)
Send an error to the admin.
NetworkRecvStatus SendCompanyEconomy()
Send economic information of all companies.
AdminUpdateFrequency update_frequency[ADMIN_UPDATE_END]
Admin requested update intervals.
NetworkAction
Actions that can be used for NetworkTextMessage.
Tindex index
Index of this pool item.
static void WelcomeAll()
Send a Welcome packet to all connected admins.
void NetworkAdminGameScript(const char *json)
Send GameScript JSON to the admin network (if they did opt in for the respective update).
NetworkRecvStatus Receive_ADMIN_JOIN(Packet *p) override
Join the admin network: string Password the server is expecting for this network.
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
static Pool::IterateWrapperFiltered< ServerNetworkAdminSocketHandler, ServerNetworkAdminSocketHandlerFilter > IterateActive(size_t from=0)
Returns an iterable ensemble of all active admin sockets.
NetworkRecvStatus SendCompanyUpdate(const Company *c)
Send an update about a company.
void NetworkAdminCompanyInfo(const Company *company, bool new_company)
Notify the admin network of company details.
Owner
Enum for all companies/owners.
NetworkRecvStatus SendCompanyInfo(const Company *c)
Send the admin some information about a company.
NetworkAddress address
Address of the admin.
static void Send()
Send the packets for the server sockets.
void NetworkAdminCompanyRemove(CompanyID company_id, AdminCompanyRemoveReason bcrr)
Notify the admin network of a company to be removed (including the reason why).
Template for TCP listeners.
NetworkRecvStatus SendShutdown()
Tell the admin we're shutting down.
void NetworkAdminClientQuit(ClientID client_id)
Notify the admin network that a client quit (if they have opt in for the respective update).
std::chrono::steady_clock::time_point connect_time
Time of connection.
Everything we need to know about a command to be able to execute it.
NetworkRecvStatus SendCompanyRemove(CompanyID company_id, AdminCompanyRemoveReason bcrr)
Tell the admin that a company got removed.
ClientID
'Unique' identifier to be given to clients
Main socket handler for admin related connections.
void NetworkAdminConsole(const char *origin, const char *string)
Send console to the admin network (if they did opt in for the respective update).
Pool< ServerNetworkAdminSocketHandler, AdminIndex, 2, MAX_ADMINS, PT_NADMIN > NetworkAdminSocketPool
Pool with all admin connections.
static bool AllowConnection()
Whether a connection is allowed or not at this moment.
NetworkRecvStatus SendWelcome()
Send a welcome message to the admin.
NetworkRecvStatus SendRcon(uint16 colour, const char *command)
Send the reply of an rcon command.
NetworkAdminSocketPool _networkadminsocket_pool
The pool with sockets/clients.
void NetworkAdminClientUpdate(const NetworkClientInfo *ci)
Notify the admin network of a client update (if they did opt in for the respective update).
AdminIndex _redirect_console_to_admin
Redirection of the (remote) console to the admin.
void NetworkAdminCompanyUpdate(const Company *company)
Notify the admin network of company updates.
~ServerNetworkAdminSocketHandler()
Clear everything related to this admin.
NetworkRecvStatus SendClientQuit(ClientID client_id)
Tell the admin that a client quit.
AdminCompanyRemoveReason
Reasons for removing a company - communicated to admins.
void NetworkAdminClientError(ClientID client_id, NetworkErrorCode error_code)
Notify the admin network of a client error (if they have opt in for the respective update).
Internal entity of a packet.
NetworkRecvStatus SendCmdNames()
Send the names of the commands.
NetworkRecvStatus SendNewGame()
Tell the admin we started a new game.
Wrapper for (un)resolved network addresses; there's no reason to transform a numeric IP to a string a...
NetworkRecvStatus SendDate()
Tell the admin the date.
NetworkRecvStatus SendCompanyNew(CompanyID company_id)
Tell the admin that a new company was founded.
Base class for all pools.
NetworkRecvStatus Receive_ADMIN_QUIT(Packet *p) override
Notification to the server that this admin is quitting.
NetworkRecvStatus SendPong(uint32 d1)
Send ping-reply (pong) to admin.
ServerNetworkAdminSocketHandler(SOCKET s)
Sanity check.
void NetworkAdminUpdate(AdminUpdateFrequency freq)
Send (push) updates to the admin network as they have registered for these updates.
Class for handling the server side of the game connection.
NetworkRecvStatus
Status of a network client; reasons why a client has quit.
NetworkRecvStatus Receive_ADMIN_POLL(Packet *p) override
Poll the server for certain updates, an invalid poll (e.g.
NetworkRecvStatus SendClientInfo(const NetworkClientSocket *cs, const NetworkClientInfo *ci)
Send an initial set of data from some client's information.
@ ADMIN_STATUS_ACTIVE
The admin is active.
NetworkRecvStatus SendProtocol()
Send the protocol version to the admin.
NetworkRecvStatus SendRconEnd(const char *command)
Send a notification indicating the rcon command has completed.
NetworkRecvStatus Receive_ADMIN_PING(Packet *p) override
Ping the server, requiring the server to reply with a pong packet.
static void AcceptConnection(SOCKET s, const NetworkAddress &address)
Handle the acception of a connection.
static const char * GetName()
Get the name used by the listener.
NetworkRecvStatus SendClientUpdate(const NetworkClientInfo *ci)
Send an update for some client's information.
void CDECL error(const char *s,...)
Error handling for fatal non-user errors.
uint8 AdminIndex
Indices into the admin tables.
NetworkRecvStatus Receive_ADMIN_RCON(Packet *p) override
Execute a command on the servers console: string Command to be executed.
NetworkRecvStatus Receive_ADMIN_CHAT(Packet *p) override
Send chat as the server: uint8 Action such as NETWORK_ACTION_CHAT_CLIENT (see NetworkAction).
NetworkRecvStatus Receive_ADMIN_GAMESCRIPT(Packet *p) override
Send a JSON string to the current active GameScript.
NetworkRecvStatus SendCompanyStats()
Send statistics about the companies.
@ ADMIN_UPDATE_END
Must ALWAYS be on the end of this list!! (period)
Base class for all PoolItems.
AdminUpdateFrequency
Update frequencies an admin can register.
NetworkRecvStatus SendClientJoin(ClientID client_id)
Tell the admin that a client joined.
NetworkRecvStatus SendChat(NetworkAction action, DestType desttype, ClientID client_id, const char *msg, int64 data)
Send a chat message.
NetworkErrorCode
The error codes we send around in the protocols.
Container for all information known about a client.
void NetworkAdminChat(NetworkAction action, DestType desttype, ClientID client_id, const char *msg, int64 data=0, bool from_admin=false)
Send chat to the admin network (if they did opt in for the respective update).
NetworkRecvStatus SendClientError(ClientID client_id, NetworkErrorCode error)
Tell the admin that a client made an error.
void NetworkAdminCmdLogging(const NetworkClientSocket *owner, const CommandPacket *cp)
Distribute CommandPacket details over the admin network for logging purposes.
NetworkRecvStatus SendCmdLogging(ClientID client_id, const CommandPacket *cp)
Send a command for logging purposes.