OpenTTD Source 20260206-master-g4d4e37dbf1
NetworkClientInfo Struct Reference

Container for all information known about a client. More...

#include <network_base.h>

Inheritance diagram for NetworkClientInfo:

Public Member Functions

 NetworkClientInfo (ClientPoolID index, ClientID client_id=INVALID_CLIENT_ID)
 Create a new client.
 ~NetworkClientInfo ()
 Basically a client is leaving us right now.
bool CanJoinCompany (CompanyID company_id) const
 Returns whether the given company can be joined by this client.

Static Public Member Functions

static NetworkClientInfo * GetByClientID (ClientID client_id)
 Return the CI given it's client-identifier.

Data Fields

ClientID client_id = INVALID_CLIENT_ID
 Client identifier (same as ClientState->client_id).
std::string client_name {}
 Name of the client.
std::string public_key {}
 The public key of the client.
CompanyID client_playas = CompanyID::Invalid()
 As which company is this client playing (CompanyID).
TimerGameEconomy::Date join_date {}
 Gamedate the client has joined.

Detailed Description

Container for all information known about a client.

Definition at line 24 of file network_base.h.

Constructor & Destructor Documentation

◆ NetworkClientInfo()

NetworkClientInfo::NetworkClientInfo ( ClientPoolID index,
ClientID client_id = INVALID_CLIENT_ID )
inline

Create a new client.

Parameters
indexThe index into the client info pool.
client_idThe unique identifier of the client.

Definition at line 36 of file network_base.h.

References client_id, and INVALID_CLIENT_ID.

Referenced by GetByClientID().

◆ ~NetworkClientInfo()

NetworkClientInfo::~NetworkClientInfo ( )

Basically a client is leaving us right now.

Definition at line 106 of file network.cpp.

References client_id, DESTTYPE_CLIENT, InvalidateWindowData(), and WC_SEND_NETWORK_MSG.

Member Function Documentation

◆ CanJoinCompany()

bool NetworkClientInfo::CanJoinCompany ( CompanyID company_id) const

Returns whether the given company can be joined by this client.

Parameters
company_idThe id of the company.
Returns
true when this company is allowed to join, otherwise false.

Definition at line 131 of file network.cpp.

References CompanyProperties::allow_list, NetworkAuthorizedKeys::Contains(), and public_key.

Referenced by NetworkCanJoinCompany().

◆ GetByClientID()

NetworkClientInfo * NetworkClientInfo::GetByClientID ( ClientID client_id)
static

Return the CI given it's client-identifier.

Parameters
client_idthe ClientID to search for
Returns
return a pointer to the corresponding NetworkClientInfo struct or nullptr when not found

Definition at line 117 of file network.cpp.

References client_id, and NetworkClientInfo().

Referenced by CmdCompanyCtrl(), CmdGoalQuestion(), NetworkChatWindow::GetWidgetString(), NetworkClientListWindow::GetWidgetString(), NetworkAutoCleanCompanies(), NetworkCanJoinCompany(), NetworkMakeClientNameUnique(), NetworkOnGameStart(), NetworkServerChangeClientName(), NetworkServerDoMove(), NetworkServerSendChat(), NetworkUpdateClientInfo(), NetworkUpdateClientName(), NetworkClientListWindow::OnClick(), NetworkClientListWindow::OnDropdownSelect(), MainWindow::OnHotkey(), NetworkClientListWindow::RebuildList(), ServerNetworkAdminSocketHandler::Receive_ADMIN_POLL(), ClientNetworkGameSocketHandler::Receive_SERVER_CHAT(), ClientNetworkGameSocketHandler::Receive_SERVER_CLIENT_INFO(), ClientNetworkGameSocketHandler::Receive_SERVER_ERROR_QUIT(), ClientNetworkGameSocketHandler::Receive_SERVER_JOIN(), ClientNetworkGameSocketHandler::Receive_SERVER_MOVE(), ClientNetworkGameSocketHandler::Receive_SERVER_QUIT(), ServerNetworkGameSocketHandler::SendWelcome(), and NetworkClientListWindow::UpdateWidgetSize().

Field Documentation

◆ client_id

ClientID NetworkClientInfo::client_id = INVALID_CLIENT_ID

Client identifier (same as ClientState->client_id).

Definition at line 25 of file network_base.h.

Referenced by CmdCompanyCtrl(), ClientButtonLine::Draw(), GetByClientID(), ClientButtonLine::GetTooltip(), NetworkClientInfo(), NetworkServerNewCompany(), NetworkServerSendChat(), ServerNetworkGameSocketHandler::Receive_CLIENT_CHAT(), ServerNetworkGameSocketHandler::Receive_CLIENT_COMMAND(), ServerNetworkGameSocketHandler::Receive_CLIENT_SET_NAME(), ServerNetworkAdminSocketHandler::SendClientInfo(), ServerNetworkGameSocketHandler::SendClientInfo(), ServerNetworkAdminSocketHandler::SendClientUpdate(), and ~NetworkClientInfo().

◆ client_name

std::string NetworkClientInfo::client_name {}

Name of the client.

Definition at line 26 of file network_base.h.

Referenced by ClientButtonLine::Draw(), ServerNetworkGameSocketHandler::GetClientName(), NetworkClientListWindow::GetWidgetString(), NetworkMakeClientNameUnique(), NetworkServerChangeClientName(), NetworkServerNewCompany(), NetworkServerSendChat(), NetworkServerShowStatusToConsole(), NetworkUpdateClientName(), NetworkClientListWindow::OnClick(), ServerNetworkGameSocketHandler::Receive_CLIENT_IDENTIFY(), ServerNetworkGameSocketHandler::Receive_CLIENT_SET_NAME(), ClientNetworkGameSocketHandler::Receive_SERVER_CLIENT_INFO(), ClientNetworkGameSocketHandler::Receive_SERVER_ERROR_QUIT(), ClientNetworkGameSocketHandler::Receive_SERVER_JOIN(), ClientNetworkGameSocketHandler::Receive_SERVER_QUIT(), ServerNetworkAdminSocketHandler::SendClientInfo(), ServerNetworkGameSocketHandler::SendClientInfo(), ServerNetworkAdminSocketHandler::SendClientUpdate(), and NetworkClientListWindow::UpdateWidgetSize().

◆ client_playas

CompanyID NetworkClientInfo::client_playas = CompanyID::Invalid()

As which company is this client playing (CompanyID).

Definition at line 28 of file network_base.h.

Referenced by CmdCompanyCtrl(), NetworkAutoCleanCompanies(), NetworkClientPreferTeamChat(), NetworkOnGameStart(), NetworkServerDoMove(), NetworkServerNewCompany(), NetworkServerSendChat(), NetworkServerShowStatusToConsole(), NetworkUpdateClientInfo(), MainWindow::OnHotkey(), NetworkClientListWindow::RebuildList(), ServerNetworkGameSocketHandler::Receive_CLIENT_COMMAND(), ServerNetworkGameSocketHandler::Receive_CLIENT_IDENTIFY(), ClientNetworkGameSocketHandler::Receive_SERVER_CHAT(), ClientNetworkGameSocketHandler::Receive_SERVER_CLIENT_INFO(), ServerNetworkAdminSocketHandler::SendClientInfo(), ServerNetworkGameSocketHandler::SendClientInfo(), and ServerNetworkAdminSocketHandler::SendClientUpdate().

◆ join_date

TimerGameEconomy::Date NetworkClientInfo::join_date {}

Gamedate the client has joined.

Definition at line 29 of file network_base.h.

Referenced by ServerNetworkGameSocketHandler::Receive_CLIENT_IDENTIFY(), and ServerNetworkAdminSocketHandler::SendClientInfo().

◆ public_key

std::string NetworkClientInfo::public_key {}

The public key of the client.

Definition at line 27 of file network_base.h.

Referenced by CanJoinCompany(), NetworkServerNewCompany(), NetworkClientListWindow::RebuildList(), ServerNetworkGameSocketHandler::Receive_CLIENT_IDENTIFY(), ClientNetworkGameSocketHandler::Receive_SERVER_CLIENT_INFO(), and ServerNetworkGameSocketHandler::SendClientInfo().

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