OpenTTD Source  20241108-master-g80f628063a
network_base.h
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #ifndef NETWORK_BASE_H
11 #define NETWORK_BASE_H
12 
13 #include "network_type.h"
14 #include "core/address.h"
15 #include "../core/pool_type.hpp"
16 #include "../company_type.h"
17 #include "../timer/timer_game_economy.h"
18 
22 
24 struct NetworkClientInfo : NetworkClientInfoPool::PoolItem<&_networkclientinfo_pool> {
26  std::string client_name;
27  std::string public_key;
30 
37 
39 
40  bool CanJoinCompany(CompanyID company_id) const;
41 };
42 
43 #endif /* NETWORK_BASE_H */
Wrapper for network addresses.
Owner
Enum for all companies/owners.
Definition: company_type.h:18
NetworkClientInfoPool _networkclientinfo_pool("NetworkClientInfo")
Make sure both pools have the same size.
Pool< NetworkClientInfo, ClientIndex, 8, MAX_CLIENT_SLOTS, PT_NCLIENT > NetworkClientInfoPool
Type for the pool with client information.
Definition: network_base.h:20
Types used for networking.
ClientID
'Unique' identifier to be given to clients
Definition: network_type.h:49
@ INVALID_CLIENT_ID
Client is not part of anything.
Definition: network_type.h:50
Container for all information known about a client.
Definition: network_base.h:24
static NetworkClientInfo * GetByClientID(ClientID client_id)
Return the CI given it's client-identifier.
Definition: network.cpp:118
TimerGameEconomy::Date join_date
Gamedate the client has joined.
Definition: network_base.h:29
~NetworkClientInfo()
Basically a client is leaving us right now.
Definition: network.cpp:107
bool CanJoinCompany(CompanyID company_id) const
Returns whether the given company can be joined by this client.
Definition: network.cpp:132
CompanyID client_playas
As which company is this client playing (CompanyID)
Definition: network_base.h:28
ClientID client_id
Client identifier (same as ClientState->client_id)
Definition: network_base.h:25
std::string client_name
Name of the client.
Definition: network_base.h:26
std::string public_key
The public key of the client.
Definition: network_base.h:27
NetworkClientInfo(ClientID client_id=INVALID_CLIENT_ID)
Create a new client.
Definition: network_base.h:35
Base class for all PoolItems.
Definition: pool_type.hpp:237
Base class for all pools.
Definition: pool_type.hpp:80
Templated helper to make a type-safe 'typedef' representing a single POD value.