|
OpenTTD Source
1.10.0-RC1
|
Container for all information known about a client. More...
#include <network_base.h>
Public Member Functions | |
| NetworkClientInfo (ClientID client_id=INVALID_CLIENT_ID) | |
| Create a new client. More... | |
| ~NetworkClientInfo () | |
| Basically a client is leaving us right now. | |
Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_networkclientinfo_pool > | |
| void * | operator new (size_t size) |
| Allocates space for new Titem. More... | |
| void * | operator new (size_t size, size_t index) |
| Allocates space for new Titem with given index. More... | |
| void * | operator new (size_t size, void *ptr) |
| Allocates space for new Titem at given memory address. More... | |
| void | operator delete (void *p) |
| Marks Titem as free. More... | |
Static Public Member Functions | |
| static NetworkClientInfo * | GetByClientID (ClientID client_id) |
| Return the CI given it's client-identifier. More... | |
Static Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_networkclientinfo_pool > | |
| static bool | CanAllocateItem (size_t n=1) |
| Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function() More... | |
| static bool | CleaningPool () |
| Returns current state of pool cleaning - yes or no. More... | |
| static bool | IsValidID (size_t index) |
| Tests whether given index can be used to get valid (non-nullptr) Titem. More... | |
| static Titem * | Get (size_t index) |
| Returns Titem with given index. More... | |
| static Titem * | GetIfValid (size_t index) |
| Returns Titem with given index. More... | |
| static size_t | GetPoolSize () |
| Returns first unused index. More... | |
| static size_t | GetNumItems () |
| Returns number of valid items in the pool. More... | |
| static void | PostDestructor (size_t index) |
| Dummy function called after destructor of each member. More... | |
| static Pool::IterateWrapper< Titem > | Iterate (size_t from=0) |
| Returns an iterable ensemble of all valid Titem. More... | |
Data Fields | |
| ClientID | client_id |
| Client identifier (same as ClientState->client_id) | |
| char | client_name [NETWORK_CLIENT_NAME_LENGTH] |
| Name of the client. | |
| byte | client_lang |
| The language of the client. | |
| CompanyID | client_playas |
| As which company is this client playing (CompanyID) | |
| Date | join_date |
| Gamedate the client has joined. | |
Data Fields inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_networkclientinfo_pool > | |
| Tindex | index |
| Index of this pool item. | |
Additional Inherited Members | |
Public Types inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_networkclientinfo_pool > | |
| typedef struct Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero > | Pool |
| Type of the pool this item is going to be part of. | |
Container for all information known about a client.
Definition at line 23 of file network_base.h.
|
inline |
Create a new client.
| client_id | The unique identifier of the client. |
Definition at line 34 of file network_base.h.
References GetByClientID(), and ~NetworkClientInfo().
|
static |
Return the CI given it's client-identifier.
| client_id | the ClientID to search for |
Definition at line 119 of file network.cpp.
Referenced by NetworkChatWindow::DrawWidget(), NetworkAutoCleanCompanies(), NetworkClientInfo(), NetworkFindName(), NetworkServerChangeClientName(), NetworkServerDoMove(), NetworkServerSendChat(), NetworkUpdateClientInfo(), NetworkUpdateClientName(), ClientNetworkGameSocketHandler::Receive_SERVER_CHAT(), ClientNetworkGameSocketHandler::Receive_SERVER_ERROR_QUIT(), ClientNetworkGameSocketHandler::Receive_SERVER_JOIN(), ClientNetworkGameSocketHandler::Receive_SERVER_QUIT(), ServerNetworkGameSocketHandler::SendCompanyInfo(), ServerNetworkGameSocketHandler::SendWelcome(), and NetworkChatWindow::UpdateWidgetSize().