network_admin.h File Reference

Server part of the admin network protocol. More...

#include "network_internal.h"
#include "core/tcp_listen.h"
#include "core/tcp_admin.h"

Go to the source code of this file.

Data Structures

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

Defines

#define FOR_ALL_ADMIN_SOCKETS_FROM(var, start)   FOR_ALL_ITEMS_FROM(ServerNetworkAdminSocketHandler, adminsocket_index, var, start)
#define FOR_ALL_ADMIN_SOCKETS(var)   FOR_ALL_ADMIN_SOCKETS_FROM(var, 0)

Typedefs

typedef Pool
< ServerNetworkAdminSocketHandler,
AdminIndex, 2, MAX_ADMINS
NetworkAdminSocketPool

Functions

void NetworkAdminClientInfo (const NetworkClientInfo *ci, bool new_client=false)
 Notify the admin network of a new client (if they did opt in for the respective update).
void NetworkAdminClientUpdate (const NetworkClientInfo *ci)
 Notify the admin network of a client update (if they did opt in for the respective update).
void NetworkAdminClientQuit (ClientID client_id)
 Notify the admin network that a client quit (if they have opt in for the respective update).
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).
void NetworkAdminCompanyInfo (const Company *company, bool new_company)
 Notify the admin network of company details.
void NetworkAdminCompanyUpdate (const Company *company)
 Notify the admin network of company updates.
void NetworkAdminCompanyRemove (CompanyID company_id, AdminCompanyRemoveReason bcrr)
 Notify the admin network of a company to be removed (including the reason why).
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).
void NetworkAdminUpdate (AdminUpdateFrequency freq)
 Send (push) updates to the admin network as they have registered for these updates.
void NetworkServerSendAdminRcon (AdminIndex admin_index, TextColour colour_code, const char *string)
 Pass the rcon reply to the admin.
void NetworkAdminConsole (const char *origin, const char *string)
 Send console to the admin network (if they did opt in for the respective update).
void NetworkAdminCmdLogging (const NetworkClientSocket *owner, const CommandPacket *cp)
 Distribute CommandPacket details over the admin network for logging purposes.

Variables

AdminIndex _redirect_console_to_admin
 Redirection of the (remote) console to the admin.
NetworkAdminSocketPool _networkadminsocket_pool

Detailed Description

Server part of the admin network protocol.

Definition in file network_admin.h.


Function Documentation

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).

Parameters:
client_id the client that made the error.
error_code the error that was caused.

Definition at line 702 of file network_admin.cpp.

References ADMIN_FREQUENCY_AUTOMATIC, ADMIN_UPDATE_CLIENT_INFO, and ServerNetworkAdminSocketHandler::update_frequency.

void NetworkAdminClientInfo ( const NetworkClientInfo ci,
bool  new_client 
)

Notify the admin network of a new client (if they did opt in for the respective update).

Parameters:
ci the client info.
new_client if this is a new client, send the respective packet too.

Definition at line 656 of file network_admin.cpp.

References ADMIN_FREQUENCY_AUTOMATIC, ADMIN_UPDATE_CLIENT_INFO, NetworkClientInfo::client_id, and ServerNetworkAdminSocketHandler::update_frequency.

void NetworkAdminClientQuit ( ClientID  client_id  ) 

Notify the admin network that a client quit (if they have opt in for the respective update).

Parameters:
client_id of the client that quit.

Definition at line 687 of file network_admin.cpp.

References ADMIN_FREQUENCY_AUTOMATIC, ADMIN_UPDATE_CLIENT_INFO, and ServerNetworkAdminSocketHandler::update_frequency.

void NetworkAdminClientUpdate ( const NetworkClientInfo ci  ) 

Notify the admin network of a client update (if they did opt in for the respective update).

Parameters:
ci the client info.

Definition at line 673 of file network_admin.cpp.

References ADMIN_FREQUENCY_AUTOMATIC, ADMIN_UPDATE_CLIENT_INFO, and ServerNetworkAdminSocketHandler::update_frequency.

void NetworkAdminCmdLogging ( const NetworkClientSocket *  owner,
const CommandPacket cp 
)

Distribute CommandPacket details over the admin network for logging purposes.

Parameters:
owner The owner of the CommandPacket (who sent us the CommandPacket).
cp The CommandPacket to be distributed.

Definition at line 811 of file network_admin.cpp.

References ADMIN_FREQUENCY_AUTOMATIC, ADMIN_UPDATE_CMD_LOGGING, and ServerNetworkAdminSocketHandler::update_frequency.

Referenced by DistributeQueue().

void NetworkAdminCompanyInfo ( const Company company,
bool  new_company 
)

Notify the admin network of company details.

Parameters:
company the company of which details will be sent into the admin network.
new_company whether this is a new company or not.

Definition at line 717 of file network_admin.cpp.

References ADMIN_FREQUENCY_AUTOMATIC, ADMIN_UPDATE_COMPANY_INFO, DEBUG, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem< Tpool >::index, and ServerNetworkAdminSocketHandler::update_frequency.

Referenced by CmdCompanyCtrl().

void NetworkAdminCompanyRemove ( CompanyID  company_id,
AdminCompanyRemoveReason  bcrr 
)

Notify the admin network of a company to be removed (including the reason why).

Parameters:
company_id ID of the company that got removed.
bcrr the reason why the company got removed (e.g. bankruptcy).

Definition at line 756 of file network_admin.cpp.

Referenced by CompanyAdminBankrupt().

void NetworkAdminCompanyUpdate ( const Company company  ) 

Notify the admin network of company updates.

Parameters:
company company of which updates are going to be sent into the admin network.

Definition at line 739 of file network_admin.cpp.

References ADMIN_FREQUENCY_AUTOMATIC, ADMIN_UPDATE_COMPANY_INFO, and ServerNetworkAdminSocketHandler::update_frequency.

Referenced by CompanyAdminUpdate().

void NetworkAdminConsole ( const char *  origin,
const char *  string 
)

Send console to the admin network (if they did opt in for the respective update).

Parameters:
origin the origin of the message.
string the message as printed on the console.

Definition at line 796 of file network_admin.cpp.

References ADMIN_FREQUENCY_AUTOMATIC, ADMIN_UPDATE_CONSOLE, and ServerNetworkAdminSocketHandler::update_frequency.

Referenced by debug_print(), and IConsolePrint().

void NetworkAdminUpdate ( AdminUpdateFrequency  freq  ) 

Send (push) updates to the admin network as they have registered for these updates.

Parameters:
freq the frequency to be processd.

Definition at line 838 of file network_admin.cpp.

References ADMIN_UPDATE_COMPANY_ECONOMY, ADMIN_UPDATE_COMPANY_STATS, ADMIN_UPDATE_DATE, and ServerNetworkAdminSocketHandler::update_frequency.

Referenced by NetworkServerDailyLoop(), NetworkServerMonthlyLoop(), and NetworkServerYearlyLoop().

void NetworkServerSendAdminRcon ( AdminIndex  admin_index,
TextColour  colour_code,
const char *  string 
)

Pass the rcon reply to the admin.

Parameters:
admin_index The admin to give the reply.
colour_code The colour of the string.
string The string to show.

Definition at line 786 of file network_admin.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_networkadminsocket_pool >::Get().

Referenced by IConsolePrint().


Variable Documentation

Redirection of the (remote) console to the admin.

Definition at line 35 of file network_admin.cpp.

Referenced by IConsolePrint(), and ServerNetworkAdminSocketHandler::~ServerNetworkAdminSocketHandler().


Generated on Thu Jan 20 22:57:47 2011 for OpenTTD by  doxygen 1.6.1