OpenTTD
Public Member Functions | Static Public Member Functions | Data Fields | Protected Member Functions
ServerNetworkAdminSocketHandler Class Reference

Class for handling the server side of the game connection. More...

#include <network_admin.h>

Inheritance diagram for ServerNetworkAdminSocketHandler:
Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_networkadminsocket_pool > NetworkAdminSocketHandler TCPListenHandler< ServerNetworkAdminSocketHandler, ADMIN_PACKET_SERVER_FULL, ADMIN_PACKET_SERVER_BANNED > NetworkTCPSocketHandler NetworkSocketHandler

Public Member Functions

 ServerNetworkAdminSocketHandler (SOCKET s)
 Create a new socket for the server side of the admin network.
 ~ServerNetworkAdminSocketHandler ()
 Clear everything related to this admin.
NetworkRecvStatus SendError (NetworkErrorCode error)
 Send an error to the admin.
NetworkRecvStatus SendWelcome ()
 Send a welcome message to the admin.
NetworkRecvStatus SendNewGame ()
 Tell the admin we started a new game.
NetworkRecvStatus SendShutdown ()
 Tell the admin we're shutting down.
NetworkRecvStatus SendDate ()
 Tell the admin the date.
NetworkRecvStatus SendClientJoin (ClientID client_id)
 Tell the admin that a client joined.
NetworkRecvStatus SendClientInfo (const NetworkClientSocket *cs, const NetworkClientInfo *ci)
 Send an initial set of data from some client's information.
NetworkRecvStatus SendClientUpdate (const NetworkClientInfo *ci)
 Send an update for some client's information.
NetworkRecvStatus SendClientQuit (ClientID client_id)
 Tell the admin that a client quit.
NetworkRecvStatus SendClientError (ClientID client_id, NetworkErrorCode error)
 Tell the admin that a client made an error.
NetworkRecvStatus SendCompanyNew (CompanyID company_id)
 Tell the admin that a new company was founded.
NetworkRecvStatus SendCompanyInfo (const Company *c)
 Send the admin some information about a company.
NetworkRecvStatus SendCompanyUpdate (const Company *c)
 Send an update about a company.
NetworkRecvStatus SendCompanyRemove (CompanyID company_id, AdminCompanyRemoveReason bcrr)
 Tell the admin that a company got removed.
NetworkRecvStatus SendCompanyEconomy ()
 Send economic information of all companies.
NetworkRecvStatus SendCompanyStats ()
 Send statistics about the companies.
NetworkRecvStatus SendChat (NetworkAction action, DestType desttype, ClientID client_id, const char *msg, int64 data)
 Send a chat message.
NetworkRecvStatus SendRcon (uint16 colour, const char *command)
 Send the reply of an rcon command.
NetworkRecvStatus SendConsole (const char *origin, const char *command)
 Send console output of other clients.
NetworkRecvStatus SendGameScript (const char *json)
 Send GameScript JSON output.
NetworkRecvStatus SendCmdNames ()
 Send the names of the commands.
NetworkRecvStatus SendCmdLogging (ClientID client_id, const CommandPacket *cp)
 Send a command for logging purposes.
NetworkRecvStatus SendRconEnd (const char *command)
 Send a notification indicating the rcon command has completed.
- Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_networkadminsocket_pool >
void * operator new (size_t size)
 Allocates space for new Titem.
void * operator new (size_t size, size_t index)
 Allocates space for new Titem with given index.
void * operator new (size_t size, void *ptr)
 Allocates space for new Titem at given memory address.
void operator delete (void *p)
 Marks Titem as free.
- Public Member Functions inherited from NetworkAdminSocketHandler
NetworkRecvStatus CloseConnection (bool error=true)
 Close the current connection; for TCP this will be mostly equivalent to Close(), but for UDP it just means the packet has to be dropped.
 NetworkAdminSocketHandler (SOCKET s)
 Create the admin handler for the given socket.
NetworkRecvStatus ReceivePackets ()
 Do the actual receiving of packets.
AdminStatus GetAdminStatus () const
 Get the status of the admin.
- Public Member Functions inherited from NetworkTCPSocketHandler
bool IsConnected () const
 Whether this socket is currently bound to a socket.
virtual void SendPacket (Packet *packet)
 This function puts the packet in the send-queue and it is send as soon as possible.
SendPacketsState SendPackets (bool closing_down=false)
 Sends all the buffered packets out for this client.
virtual PacketReceivePacket ()
 Receives a packet for the given client.
bool CanSendReceive ()
 Check whether this socket can send or receive something.
bool HasSendQueue ()
 Whether there is something pending in the send queue.
 NetworkTCPSocketHandler (SOCKET s=INVALID_SOCKET)
 Construct a socket handler for a TCP connection.
- Public Member Functions inherited from NetworkSocketHandler
 NetworkSocketHandler ()
 Create a new unbound socket.
virtual ~NetworkSocketHandler ()
 Close the socket when destructing the socket handler.
virtual void Close ()
 Really close the socket.
bool HasClientQuit () const
 Whether the current client connected to the socket has quit.
void Reopen ()
 Reopen the socket so we can send/receive stuff again.
void SendGRFIdentifier (Packet *p, const GRFIdentifier *grf)
 Serializes the GRFIdentifier (GRF ID and MD5 checksum) to the packet.
void ReceiveGRFIdentifier (Packet *p, GRFIdentifier *grf)
 Deserializes the GRFIdentifier (GRF ID and MD5 checksum) from the packet.
void SendCompanyInformation (Packet *p, const struct Company *c, const struct NetworkCompanyStats *stats, uint max_len=NETWORK_COMPANY_NAME_LENGTH)
 Package some generic company information into a packet.

Static Public Member Functions

static void Send ()
 Send the packets for the server sockets.
static void AcceptConnection (SOCKET s, const NetworkAddress &address)
 Handle the acception of a connection.
static bool AllowConnection ()
 Whether a connection is allowed or not at this moment.
static void WelcomeAll ()
 Send a Welcome packet to all connected admins.
static const char * GetName ()
 Get the name used by the listener.
- Static Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_networkadminsocket_pool >
static bool CanAllocateItem (size_t n=1)
 Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function()
static bool CleaningPool ()
 Returns current state of pool cleaning - yes or no.
static bool IsValidID (size_t index)
 Tests whether given index can be used to get valid (non-NULL) Titem.
static Titem * Get (size_t index)
 Returns Titem with given index.
static Titem * GetIfValid (size_t index)
 Returns Titem with given index.
static size_t GetPoolSize ()
 Returns first unused index.
static size_t GetNumItems ()
 Returns number of valid items in the pool.
static void PostDestructor (size_t index)
 Dummy function called after destructor of each member.
- Static Public Member Functions inherited from TCPListenHandler< ServerNetworkAdminSocketHandler, ADMIN_PACKET_SERVER_FULL, ADMIN_PACKET_SERVER_BANNED >
static void AcceptClient (SOCKET ls)
 Accepts clients from the sockets.
static bool Receive ()
 Handle the receiving of packets.
static bool Listen (uint16 port)
 Listen on a particular port.
static void CloseListeners ()
 Close the sockets we're listening on.

Data Fields

AdminUpdateFrequency update_frequency [ADMIN_UPDATE_END]
 Admin requested update intervals.
uint32 realtime_connect
 Time of connection.
NetworkAddress address
 Address of the admin.
- Data Fields inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_networkadminsocket_pool >
Tindex index
 Index of this pool item.

Protected Member Functions

virtual NetworkRecvStatus Receive_ADMIN_JOIN (Packet *p)
 Join the admin network: string Password the server is expecting for this network.
virtual NetworkRecvStatus Receive_ADMIN_QUIT (Packet *p)
 Notification to the server that this admin is quitting.
virtual NetworkRecvStatus Receive_ADMIN_UPDATE_FREQUENCY (Packet *p)
 Register updates to be sent at certain frequencies (as announced in the PROTOCOL packet): uint16 Update type (see AdminUpdateType).
virtual NetworkRecvStatus Receive_ADMIN_POLL (Packet *p)
 Poll the server for certain updates, an invalid poll (e.g.
virtual NetworkRecvStatus Receive_ADMIN_CHAT (Packet *p)
 Send chat as the server: uint8 Action such as NETWORK_ACTION_CHAT_CLIENT (see NetworkAction).
virtual NetworkRecvStatus Receive_ADMIN_RCON (Packet *p)
 Execute a command on the servers console: string Command to be executed.
virtual NetworkRecvStatus Receive_ADMIN_GAMESCRIPT (Packet *p)
 Send a JSON string to the current active GameScript.
virtual NetworkRecvStatus Receive_ADMIN_PING (Packet *p)
 Ping the server, requiring the server to reply with a pong packet.
NetworkRecvStatus SendProtocol ()
 Send the protocol version to the admin.
NetworkRecvStatus SendPong (uint32 d1)
 Send ping-reply (pong) to admin.
- Protected Member Functions inherited from NetworkAdminSocketHandler
NetworkRecvStatus ReceiveInvalidPacket (PacketAdminType type)
 Helper for logging receiving invalid packets.
virtual NetworkRecvStatus Receive_SERVER_FULL (Packet *p)
 The server is full (connection gets closed).
virtual NetworkRecvStatus Receive_SERVER_BANNED (Packet *p)
 The source IP address is banned (connection gets closed).
virtual NetworkRecvStatus Receive_SERVER_ERROR (Packet *p)
 An error was caused by this admin connection (connection gets closed).
virtual NetworkRecvStatus Receive_SERVER_PROTOCOL (Packet *p)
 Inform a just joined admin about the protocol specifics: uint8 Protocol version.
virtual NetworkRecvStatus Receive_SERVER_WELCOME (Packet *p)
 Welcome a connected admin to the game: string Name of the Server (e.g.
virtual NetworkRecvStatus Receive_SERVER_NEWGAME (Packet *p)
 Notification about a newgame.
virtual NetworkRecvStatus Receive_SERVER_SHUTDOWN (Packet *p)
 Notification about the server shutting down.
virtual NetworkRecvStatus Receive_SERVER_DATE (Packet *p)
 Send the current date of the game: uint32 Current game date.
virtual NetworkRecvStatus Receive_SERVER_CLIENT_JOIN (Packet *p)
 Notification of a new client: uint32 ID of the new client.
virtual NetworkRecvStatus Receive_SERVER_CLIENT_INFO (Packet *p)
 Client information of a specific client: uint32 ID of the client.
virtual NetworkRecvStatus Receive_SERVER_CLIENT_UPDATE (Packet *p)
 Client update details on a specific client (e.g.
virtual NetworkRecvStatus Receive_SERVER_CLIENT_QUIT (Packet *p)
 Notification about a client leaving the game.
virtual NetworkRecvStatus Receive_SERVER_CLIENT_ERROR (Packet *p)
 Notification about a client error (and thus the clients disconnection).
virtual NetworkRecvStatus Receive_SERVER_COMPANY_NEW (Packet *p)
 Notification of a new company: uint8 ID of the new company.
virtual NetworkRecvStatus Receive_SERVER_COMPANY_INFO (Packet *p)
 Company information on a specific company: uint8 ID of the company.
virtual NetworkRecvStatus Receive_SERVER_COMPANY_UPDATE (Packet *p)
 Company information of a specific company: uint8 ID of the company.
virtual NetworkRecvStatus Receive_SERVER_COMPANY_REMOVE (Packet *p)
 Notification about a removed company (e.g.
virtual NetworkRecvStatus Receive_SERVER_COMPANY_ECONOMY (Packet *p)
 Economy update of a specific company: uint8 ID of the company.
virtual NetworkRecvStatus Receive_SERVER_COMPANY_STATS (Packet *p)
 Company statistics on stations and vehicles: uint8 ID of the company.
virtual NetworkRecvStatus Receive_SERVER_CHAT (Packet *p)
 Send chat from the game into the admin network: uint8 Action such as NETWORK_ACTION_CHAT_CLIENT (see NetworkAction).
virtual NetworkRecvStatus Receive_SERVER_RCON (Packet *p)
 Result of an rcon command: uint16 Colour as it would be used on the server or a client.
virtual NetworkRecvStatus Receive_SERVER_CONSOLE (Packet *p)
 Send what would be printed on the server's console also into the admin network.
virtual NetworkRecvStatus Receive_SERVER_CMD_NAMES (Packet *p)
 Send DoCommand names to the bot upon request only.
virtual NetworkRecvStatus Receive_SERVER_CMD_LOGGING (Packet *p)
 Send incoming command packets to the admin network.
virtual NetworkRecvStatus Receive_SERVER_PONG (Packet *p)
 Send a ping-reply (pong) to the admin that sent us the ping packet.
virtual NetworkRecvStatus Receive_SERVER_RCON_END (Packet *p)
 Notify the admin connection that the rcon command has finished.
NetworkRecvStatus HandlePacket (Packet *p)
 Handle the given packet, i.e.

Additional Inherited Members

- Protected Attributes inherited from NetworkAdminSocketHandler
char admin_name [NETWORK_CLIENT_NAME_LENGTH]
 Name of the admin.
char admin_version [NETWORK_REVISION_LENGTH]
 Version string of the admin.
AdminStatus status
 Status of this admin.

Detailed Description

Class for handling the server side of the game connection.

Definition at line 29 of file network_admin.h.

Constructor & Destructor Documentation

ServerNetworkAdminSocketHandler::ServerNetworkAdminSocketHandler ( SOCKET  s)

Create a new socket for the server side of the admin network.

Parameters
sThe socket to connect with.

Definition at line 67 of file network_admin.cpp.

References _network_admins_connected, _realtime_tick, ADMIN_STATUS_INACTIVE, realtime_connect, and NetworkAdminSocketHandler::status.

Referenced by AcceptConnection().

Member Function Documentation

void ServerNetworkAdminSocketHandler::AcceptConnection ( SOCKET  s,
const NetworkAddress address 
)
static

Handle the acception of a connection.

Parameters
sThe socket of the new connection.
addressThe address of the peer.

Definition at line 119 of file network_admin.cpp.

References address, and ServerNetworkAdminSocketHandler().

bool ServerNetworkAdminSocketHandler::AllowConnection ( )
static
static const char* ServerNetworkAdminSocketHandler::GetName ( )
inlinestatic

Get the name used by the listener.

Returns
the name to show in debug logs and the like.

Definition at line 85 of file network_admin.h.

NetworkRecvStatus ServerNetworkAdminSocketHandler::Receive_ADMIN_CHAT ( Packet p)
protectedvirtual

Send chat as the server: uint8 Action such as NETWORK_ACTION_CHAT_CLIENT (see NetworkAction).

uint8 Destination type such as DESTTYPE_BROADCAST (see DestType). uint32 ID of the destination such as company or client id. string Message.

Parameters
pThe packet that was just received.
Returns
The state the network should have.

Reimplemented from NetworkAdminSocketHandler.

Definition at line 790 of file network_admin.cpp.

References _network_own_client_id, NetworkAdminSocketHandler::admin_name, ADMIN_STATUS_INACTIVE, NetworkAdminSocketHandler::admin_version, DEBUG, NETWORK_CHAT_LENGTH, NETWORK_RECV_STATUS_OKAY, NetworkServerSendChat(), Packet::Recv_string(), Packet::Recv_uint32(), Packet::Recv_uint8(), SendError(), and NetworkAdminSocketHandler::status.

NetworkRecvStatus ServerNetworkAdminSocketHandler::Receive_ADMIN_GAMESCRIPT ( Packet p)
protectedvirtual

Send a JSON string to the current active GameScript.

json JSON string for the GameScript.

Parameters
pThe packet that was just received.
Returns
The state the network should have.

Reimplemented from NetworkAdminSocketHandler.

Definition at line 536 of file network_admin.cpp.

References NetworkAdminSocketHandler::admin_name, ADMIN_STATUS_INACTIVE, NetworkAdminSocketHandler::admin_version, DEBUG, NETWORK_GAMESCRIPT_JSON_LENGTH, NETWORK_RECV_STATUS_OKAY, Game::NewEvent(), Packet::Recv_string(), SendError(), and NetworkAdminSocketHandler::status.

NetworkRecvStatus ServerNetworkAdminSocketHandler::Receive_ADMIN_JOIN ( Packet p)
protectedvirtual

Join the admin network: string Password the server is expecting for this network.

string Name of the application being used to connect. string Version string of the application being used to connect.

Parameters
pThe packet that was just received.
Returns
The state the network should have.

Reimplemented from NetworkAdminSocketHandler.

Definition at line 670 of file network_admin.cpp.

References _settings_client, NetworkAdminSocketHandler::admin_name, NetworkSettings::admin_password, ADMIN_STATUS_ACTIVE, ADMIN_STATUS_INACTIVE, NetworkAdminSocketHandler::admin_version, DEBUG, ClientSettings::network, NETWORK_PASSWORD_LENGTH, Packet::Recv_string(), SendError(), SendProtocol(), NetworkAdminSocketHandler::status, and StrEmpty().

NetworkRecvStatus ServerNetworkAdminSocketHandler::Receive_ADMIN_PING ( Packet p)
protectedvirtual

Ping the server, requiring the server to reply with a pong packet.

uint32 Integer value to pass to the server, which is quoted in the reply.

Parameters
pThe packet that was just received.
Returns
The state the network should have.

Reimplemented from NetworkAdminSocketHandler.

Definition at line 550 of file network_admin.cpp.

References NetworkAdminSocketHandler::admin_name, ADMIN_STATUS_INACTIVE, NetworkAdminSocketHandler::admin_version, DEBUG, Packet::Recv_uint32(), SendError(), SendPong(), and NetworkAdminSocketHandler::status.

NetworkRecvStatus ServerNetworkAdminSocketHandler::Receive_ADMIN_POLL ( Packet p)
protectedvirtual

Poll the server for certain updates, an invalid poll (e.g.

not existent id) gets silently dropped: uint8 AdminUpdateType the server should answer for, only if AdminUpdateFrequency ADMIN_FREQUENCY_POLL is advertised in the PROTOCOL packet. uint32 ID relevant to the packet type, e.g.

  • the client ID for ADMIN_UPDATE_CLIENT_INFO. Use UINT32_MAX to show all clients.
  • the company ID for ADMIN_UPDATE_COMPANY_INFO. Use UINT32_MAX to show all companies.
    Parameters
    pThe packet that was just received.
    Returns
    The state the network should have.

Reimplemented from NetworkAdminSocketHandler.

Definition at line 722 of file network_admin.cpp.

References NetworkAdminSocketHandler::admin_name, ADMIN_STATUS_INACTIVE, ADMIN_UPDATE_CLIENT_INFO, ADMIN_UPDATE_CMD_NAMES, ADMIN_UPDATE_COMPANY_ECONOMY, ADMIN_UPDATE_COMPANY_INFO, ADMIN_UPDATE_COMPANY_STATS, ADMIN_UPDATE_DATE, NetworkAdminSocketHandler::admin_version, CLIENT_ID_SERVER, DEBUG, FOR_ALL_CLIENT_SOCKETS, NetworkClientInfo::GetByClientID(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_networkadminsocket_pool >::GetIfValid(), NETWORK_RECV_STATUS_OKAY, Packet::Recv_uint32(), Packet::Recv_uint8(), SendClientInfo(), SendCmdNames(), SendCompanyEconomy(), SendCompanyInfo(), SendCompanyStats(), SendDate(), SendError(), and NetworkAdminSocketHandler::status.

NetworkRecvStatus ServerNetworkAdminSocketHandler::Receive_ADMIN_QUIT ( Packet p)
protectedvirtual

Notification to the server that this admin is quitting.

Parameters
pThe packet that was just received.
Returns
The state the network should have.

Reimplemented from NetworkAdminSocketHandler.

Definition at line 698 of file network_admin.cpp.

References NetworkAdminSocketHandler::CloseConnection().

NetworkRecvStatus ServerNetworkAdminSocketHandler::Receive_ADMIN_RCON ( Packet p)
protectedvirtual
NetworkRecvStatus ServerNetworkAdminSocketHandler::Receive_ADMIN_UPDATE_FREQUENCY ( Packet p)
protectedvirtual

Register updates to be sent at certain frequencies (as announced in the PROTOCOL packet): uint16 Update type (see AdminUpdateType).

uint16 Update frequency (see AdminUpdateFrequency), setting ADMIN_FREQUENCY_POLL is always ignored.

Parameters
pThe packet that was just received.
Returns
The state the network should have.

Reimplemented from NetworkAdminSocketHandler.

Definition at line 704 of file network_admin.cpp.

References _admin_update_type_frequencies, NetworkAdminSocketHandler::admin_name, ADMIN_STATUS_INACTIVE, ADMIN_UPDATE_END, NetworkAdminSocketHandler::admin_version, DEBUG, NETWORK_RECV_STATUS_OKAY, Packet::Recv_uint16(), SendError(), NetworkAdminSocketHandler::status, and update_frequency.

void ServerNetworkAdminSocketHandler::Send ( )
static
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendChat ( NetworkAction  action,
DestType  desttype,
ClientID  client_id,
const char *  msg,
int64  data 
)

Send a chat message.

Parameters
actionThe action associated with the message.
desttypeThe destination type.
client_idThe origin of the chat message.
msgThe actual message.
dataArbitrary extra data.

Definition at line 476 of file network_admin.cpp.

References ADMIN_PACKET_SERVER_CHAT, NETWORK_RECV_STATUS_OKAY, Packet::Send_string(), Packet::Send_uint32(), Packet::Send_uint64(), Packet::Send_uint8(), and NetworkTCPSocketHandler::SendPacket().

Referenced by NetworkAdminChat().

NetworkRecvStatus ServerNetworkAdminSocketHandler::SendClientError ( ClientID  client_id,
NetworkErrorCode  error 
)

Tell the admin that a client made an error.

Parameters
client_idThe client that made the error.
errorThe error that was made.

Definition at line 292 of file network_admin.cpp.

References ADMIN_PACKET_SERVER_CLIENT_ERROR, NETWORK_RECV_STATUS_OKAY, Packet::Send_uint32(), Packet::Send_uint8(), and NetworkTCPSocketHandler::SendPacket().

Referenced by NetworkAdminClientError().

NetworkRecvStatus ServerNetworkAdminSocketHandler::SendClientInfo ( const NetworkClientSocket cs,
const NetworkClientInfo ci 
)
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendClientJoin ( ClientID  client_id)

Tell the admin that a client joined.

Parameters
client_idThe client that joined.

Definition at line 221 of file network_admin.cpp.

References ADMIN_PACKET_SERVER_CLIENT_JOIN, NETWORK_RECV_STATUS_OKAY, Packet::Send_uint32(), and NetworkTCPSocketHandler::SendPacket().

Referenced by NetworkAdminClientInfo().

NetworkRecvStatus ServerNetworkAdminSocketHandler::SendClientQuit ( ClientID  client_id)

Tell the admin that a client quit.

Parameters
client_idThe client that quit.

Definition at line 277 of file network_admin.cpp.

References ADMIN_PACKET_SERVER_CLIENT_QUIT, NETWORK_RECV_STATUS_OKAY, Packet::Send_uint32(), and NetworkTCPSocketHandler::SendPacket().

Referenced by NetworkAdminClientQuit().

NetworkRecvStatus ServerNetworkAdminSocketHandler::SendClientUpdate ( const NetworkClientInfo ci)
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCmdLogging ( ClientID  client_id,
const CommandPacket cp 
)
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCmdNames ( )
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCompanyEconomy ( )
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCompanyInfo ( const Company c)
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCompanyNew ( CompanyID  company_id)

Tell the admin that a new company was founded.

Parameters
company_idThe company that was founded.

Definition at line 307 of file network_admin.cpp.

References ADMIN_PACKET_SERVER_COMPANY_NEW, NETWORK_RECV_STATUS_OKAY, Packet::Send_uint8(), and NetworkTCPSocketHandler::SendPacket().

Referenced by NetworkAdminCompanyInfo().

NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCompanyRemove ( CompanyID  company_id,
AdminCompanyRemoveReason  acrr 
)

Tell the admin that a company got removed.

Parameters
company_idThe company that got removed.
acrrThe reason for removal, e.g. bankruptcy or merger.

Definition at line 391 of file network_admin.cpp.

References ADMIN_PACKET_SERVER_COMPANY_REMOVE, NETWORK_RECV_STATUS_OKAY, Packet::Send_uint8(), and NetworkTCPSocketHandler::SendPacket().

Referenced by NetworkAdminCompanyRemove().

NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCompanyStats ( )
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendCompanyUpdate ( const Company c)
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendConsole ( const char *  origin,
const char *  string 
)

Send console output of other clients.

Parameters
originThe origin of the string.
stringThe string that's put on the console.

Definition at line 566 of file network_admin.cpp.

References ADMIN_PACKET_SERVER_CONSOLE, NETWORK_RECV_STATUS_OKAY, SEND_MTU, Packet::Send_string(), and NetworkTCPSocketHandler::SendPacket().

Referenced by NetworkAdminConsole().

NetworkRecvStatus ServerNetworkAdminSocketHandler::SendDate ( )
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendError ( NetworkErrorCode  error)
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendGameScript ( const char *  json)

Send GameScript JSON output.

Parameters
jsonThe JSON string.

Definition at line 587 of file network_admin.cpp.

References ADMIN_PACKET_SERVER_GAMESCRIPT, NETWORK_GAMESCRIPT_JSON_LENGTH, NETWORK_RECV_STATUS_OKAY, Packet::Send_string(), and NetworkTCPSocketHandler::SendPacket().

Referenced by NetworkAdminGameScript().

NetworkRecvStatus ServerNetworkAdminSocketHandler::SendNewGame ( )

Tell the admin we started a new game.

Definition at line 191 of file network_admin.cpp.

References ADMIN_PACKET_SERVER_NEWGAME, NETWORK_RECV_STATUS_OKAY, and NetworkTCPSocketHandler::SendPacket().

NetworkRecvStatus ServerNetworkAdminSocketHandler::SendProtocol ( )
protected
NetworkRecvStatus ServerNetworkAdminSocketHandler::SendRcon ( uint16  colour,
const char *  result 
)

Send the reply of an rcon command.

Parameters
colourThe colour of the text.
resultThe result of the command.

Definition at line 509 of file network_admin.cpp.

References ADMIN_PACKET_SERVER_RCON, NETWORK_RECV_STATUS_OKAY, Packet::Send_string(), Packet::Send_uint16(), and NetworkTCPSocketHandler::SendPacket().

NetworkRecvStatus ServerNetworkAdminSocketHandler::SendRconEnd ( const char *  command)

Send a notification indicating the rcon command has completed.

Parameters
commandThe original command sent.

Definition at line 494 of file network_admin.cpp.

References ADMIN_PACKET_SERVER_RCON_END, NETWORK_RECV_STATUS_OKAY, Packet::Send_string(), and NetworkTCPSocketHandler::SendPacket().

Referenced by Receive_ADMIN_RCON().

NetworkRecvStatus ServerNetworkAdminSocketHandler::SendShutdown ( )

Tell the admin we're shutting down.

Definition at line 199 of file network_admin.cpp.

References ADMIN_PACKET_SERVER_SHUTDOWN, NETWORK_RECV_STATUS_OKAY, and NetworkTCPSocketHandler::SendPacket().

Referenced by NetworkDisconnect().

NetworkRecvStatus ServerNetworkAdminSocketHandler::SendWelcome ( )

The documentation for this class was generated from the following files: