OpenTTD Source
20240917-master-g9ab0a47812
|
Go to the documentation of this file.
10 #ifndef NETWORK_ADMIN_H
11 #define NETWORK_ADMIN_H
NetworkRecvStatus SendPong(uint32_t d1)
Send ping-reply (pong) to admin.
static Titem * Get(size_t index)
Returns Titem with given index.
NetworkRecvStatus Receive_ADMIN_UPDATE_FREQUENCY(Packet &p) override
Register updates to be sent at certain frequencies (as announced in the PROTOCOL packet): uint16_t Up...
void NetworkAdminConsole(const std::string_view origin, const std::string_view string)
Send console to the admin network (if they did opt in for the respective update).
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 SendRconEnd(const std::string_view command)
Send a notification indicating the rcon command has completed.
NetworkRecvStatus SendCompanyEconomy()
Send economic information of all companies.
AdminUpdateFrequency update_frequency[ADMIN_UPDATE_END]
Admin requested update intervals.
NetworkRecvStatus Receive_ADMIN_POLL(Packet &p) override
Poll the server for certain updates, an invalid poll (e.g.
NetworkAction
Actions that can be used for NetworkTextMessage.
NetworkRecvStatus Receive_ADMIN_AUTH_RESPONSE(Packet &p) override
Admin responds to ADMIN_PACKET_SERVER_AUTH_REQUEST with the appropriate data given the agreed upon Ne...
Owner
Enum for all companies/owners.
Tindex index
Index of this pool item.
static void WelcomeAll()
Send a Welcome packet to all connected admins.
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
DestType
Destination of our chat messages.
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.
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.
NetworkRecvStatus Receive_ADMIN_GAMESCRIPT(Packet &p) override
Send a JSON string to the current active GameScript.
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.
void NetworkAdminGameScript(const std::string_view json)
Send GameScript JSON to the admin network (if they did opt in for the respective update).
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).
NetworkRecvStatus Receive_ADMIN_PING(Packet &p) override
Ping the server, requiring the server to reply with a pong packet.
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 SendConsole(const std::string_view origin, const std::string_view command)
Send console output of other clients.
void NetworkServerSendAdminRcon(AdminIndex admin_index, TextColour colour_code, const std::string_view string)
Pass the rcon reply to the admin.
NetworkRecvStatus SendCompanyRemove(CompanyID company_id, AdminCompanyRemoveReason bcrr)
Tell the admin that a company got removed.
Main socket handler for admin related connections.
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 SendGameScript(const std::string_view json)
Send GameScript JSON output.
NetworkAdminSocketPool _networkadminsocket_pool
The pool with sockets/clients.
NetworkRecvStatus Receive_ADMIN_CHAT(Packet &p) override
Send chat as the server: uint8_t Action such as NETWORK_ACTION_CHAT_CLIENT (see NetworkAction).
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.
NetworkRecvStatus SendCmdLogging(ClientID client_id, const CommandPacket &cp)
Send a command for logging purposes.
void NetworkAdminCompanyUpdate(const Company *company)
Notify the admin network of company updates.
NetworkRecvStatus Receive_ADMIN_JOIN_SECURE(Packet &p) override
Join the admin network using a secure authentication method: string Name of the application being use...
~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 NetworkAdminChat(NetworkAction action, DestType desttype, ClientID client_id, const std::string &msg, int64_t data=0, bool from_admin=false)
Send chat to the admin network (if they did opt in for the respective update).
NetworkRecvStatus Receive_ADMIN_EXTERNAL_CHAT(Packet &p) override
Send chat from the external source: string Name of the source this message came from.
void NetworkAdminCompanyNew(const Company *company)
Notify the admin network of a new company.
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 Receive_ADMIN_RCON(Packet &p) override
Execute a command on the servers console: string Command to be executed.
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.
ClientID
'Unique' identifier to be given to clients
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 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 SendChat(NetworkAction action, DestType desttype, ClientID client_id, const std::string &msg, int64_t data)
Send a chat message.
std::unique_ptr< NetworkAuthenticationServerHandler > authentication_handler
The handler for the authentication.
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.
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.
void NetworkAdminCmdLogging(const NetworkClientSocket *owner, const CommandPacket &cp)
Distribute CommandPacket details over the admin network for logging purposes.
NetworkRecvStatus SendClientJoin(ClientID client_id)
Tell the admin that a client joined.
uint8_t AdminIndex
Indices into the admin tables.
NetworkErrorCode
The error codes we send around in the protocols.
Container for all information known about a client.
NetworkRecvStatus Receive_ADMIN_JOIN(Packet &p) override
Join the admin network using an unsecured password exchange: string Unsecured password the server is ...
NetworkRecvStatus SendRcon(uint16_t colour, const std::string_view command)
Send the reply of an rcon command.
NetworkRecvStatus SendClientError(ClientID client_id, NetworkErrorCode error)
Tell the admin that a client made an error.