OpenTTD Source  20240917-master-g9ab0a47812
network_func.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_FUNC_H
11 #define NETWORK_FUNC_H
12 
17 // #define DEBUG_DUMP_COMMANDS
18 // #define DEBUG_FAILED_DUMP_COMMANDS
19 
20 #include "network_type.h"
21 #include "../console_type.h"
22 #include "../gfx_type.h"
23 #include "../openttd.h"
24 #include "../company_type.h"
25 #include "../string_type.h"
26 
27 extern ClientID _network_own_client_id;
28 extern ClientID _redirect_console_to_client;
29 extern uint8_t _network_reconnect;
30 extern StringList _network_bind_list;
31 extern StringList _network_host_list;
32 extern StringList _network_ban_list;
33 
34 uint8_t NetworkSpectatorCount();
35 bool NetworkIsValidClientName(const std::string_view client_name);
36 bool NetworkValidateOurClientName();
37 bool NetworkValidateClientName(std::string &client_name);
38 bool NetworkValidateServerName(std::string &server_name);
39 void NetworkUpdateClientName(const std::string &client_name);
40 void NetworkUpdateServerGameType();
41 bool NetworkCompanyHasClients(CompanyID company);
42 void NetworkReboot();
43 void NetworkDisconnect(bool close_admins = true);
44 void NetworkGameLoop();
45 void NetworkBackgroundLoop();
46 std::string_view ParseFullConnectionString(const std::string &connection_string, uint16_t &port, CompanyID *company_id = nullptr);
47 void NetworkPopulateCompanyStats(NetworkCompanyStats *stats);
48 
49 void NetworkUpdateClientInfo(ClientID client_id);
50 void NetworkClientsToSpectators(CompanyID cid);
51 bool NetworkClientConnectGame(const std::string &connection_string, CompanyID default_company, const std::string &join_server_password = "");
52 void NetworkClientJoinGame();
53 void NetworkClientRequestMove(CompanyID company);
54 void NetworkClientSendRcon(const std::string &password, const std::string &command);
55 void NetworkClientSendChat(NetworkAction action, DestType type, int dest, const std::string &msg, int64_t data = 0);
56 bool NetworkClientPreferTeamChat(const NetworkClientInfo *cio);
57 uint NetworkMaxCompaniesAllowed();
58 bool NetworkMaxCompaniesReached();
59 void NetworkPrintClients();
60 std::string_view NetworkGetPublicKeyOfClient(ClientID client_id);
61 void NetworkHandlePauseChange(PauseMode prev_mode, PauseMode changed_mode);
62 
63 void NetworkOnGameStart();
64 
65 /*** Commands ran by the server ***/
66 void NetworkServerSendConfigUpdate();
67 void NetworkServerUpdateGameInfo();
68 void NetworkServerShowStatusToConsole();
69 bool NetworkServerStart();
70 void NetworkServerNewCompany(const Company *company, NetworkClientInfo *ci);
71 bool NetworkServerChangeClientName(ClientID client_id, const std::string &new_name);
72 
73 
74 bool NetworkCanJoinCompany(CompanyID company_id);
75 void NetworkServerDoMove(ClientID client_id, CompanyID company_id);
76 void NetworkServerSendRcon(ClientID client_id, TextColour colour_code, const std::string &string);
77 void NetworkServerSendChat(NetworkAction action, DestType type, int dest, const std::string &msg, ClientID from_id, int64_t data = 0, bool from_admin = false);
78 void NetworkServerSendExternalChat(const std::string &source, TextColour colour, const std::string &user, const std::string &msg);
79 
80 void NetworkServerKickClient(ClientID client_id, const std::string &reason);
81 uint NetworkServerKickOrBanIP(ClientID client_id, bool ban, const std::string &reason);
82 uint NetworkServerKickOrBanIP(const std::string &ip, bool ban, const std::string &reason);
83 
84 void NetworkInitChatMessage();
85 void NetworkReInitChatBoxSize();
86 void CDECL NetworkAddChatMessage(TextColour colour, uint duration, const std::string &message);
87 void NetworkUndrawChatMessage();
88 
89 void NetworkAfterNewGRFScan();
90 
91 #endif /* NETWORK_FUNC_H */
NetworkMaxCompaniesAllowed
uint NetworkMaxCompaniesAllowed()
Get the maximum number of companies that are allowed by the server.
Definition: network_client.cpp:1389
NetworkCompanyStats
Simple calculated statistics of a company.
Definition: network_type.h:67
NetworkServerShowStatusToConsole
void NetworkServerShowStatusToConsole()
Show the status message of all clients on the console.
Definition: network_server.cpp:1931
NetworkAction
NetworkAction
Actions that can be used for NetworkTextMessage.
Definition: network_type.h:90
NetworkCompanyHasClients
bool NetworkCompanyHasClients(CompanyID company)
Check whether a particular company has clients.
Definition: network_server.cpp:2091
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
NetworkPopulateCompanyStats
void NetworkPopulateCompanyStats(NetworkCompanyStats *stats)
Populate the company stats.
Definition: network_server.cpp:1499
NetworkUpdateClientInfo
void NetworkUpdateClientInfo(ClientID client_id)
Send updated client info of a particular client.
Definition: network_server.cpp:1535
NetworkClientSendRcon
void NetworkClientSendRcon(const std::string &password, const std::string &command)
Send a remote console command.
Definition: network_client.cpp:1247
NetworkServerDoMove
void NetworkServerDoMove(ClientID client_id, CompanyID company_id)
Handle the tid-bits of moving a client from one company to another.
Definition: network_server.cpp:1983
TextColour
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:260
DestType
DestType
Destination of our chat messages.
Definition: network_type.h:79
NetworkHandlePauseChange
void NetworkHandlePauseChange(PauseMode prev_mode, PauseMode changed_mode)
Handle the pause mode change so we send the right messages to the chat.
Definition: network.cpp:356
NetworkServerSendChat
void NetworkServerSendChat(NetworkAction action, DestType type, int dest, const std::string &msg, ClientID from_id, int64_t data=0, bool from_admin=false)
Send an actual chat message.
Definition: network_server.cpp:1258
_network_bind_list
StringList _network_bind_list
The addresses to bind on.
Definition: network.cpp:73
NetworkDisconnect
void NetworkDisconnect(bool close_admins=true)
We want to disconnect from the host/clients.
Definition: network.cpp:1001
ParseFullConnectionString
std::string_view ParseFullConnectionString(const std::string &connection_string, uint16_t &port, CompanyID *company_id=nullptr)
Converts a string to ip/port/company Format: IP:port::company.
Definition: network.cpp:523
NetworkUpdateServerGameType
void NetworkUpdateServerGameType()
The setting server_game_type was updated; possibly we need to take some action.
Definition: network.cpp:1029
NetworkIsValidClientName
bool NetworkIsValidClientName(const std::string_view client_name)
Check whether the given client name is deemed valid for use in network games.
Definition: network_client.cpp:1287
NetworkGetPublicKeyOfClient
std::string_view NetworkGetPublicKeyOfClient(ClientID client_id)
Get the public key of the client with the given id.
Definition: network_server.cpp:2139
NetworkClientConnectGame
bool NetworkClientConnectGame(const std::string &connection_string, CompanyID default_company, const std::string &join_server_password="")
Join a client to the server at with the given connection string.
Definition: network.cpp:787
NetworkCanJoinCompany
bool NetworkCanJoinCompany(CompanyID company_id)
Returns whether the given company can be joined by this client.
Definition: network.cpp:143
NetworkClientJoinGame
void NetworkClientJoinGame()
Actually perform the joining to the server.
Definition: network.cpp:820
NetworkClientSendChat
void NetworkClientSendChat(NetworkAction action, DestType type, int dest, const std::string &msg, int64_t data=0)
Send a chat message.
Definition: network_client.cpp:1363
NetworkPrintClients
void NetworkPrintClients()
Print all the clients to the console.
Definition: network_server.cpp:2116
StringList
std::vector< std::string > StringList
Type for a list of strings.
Definition: string_type.h:60
NetworkServerChangeClientName
bool NetworkServerChangeClientName(ClientID client_id, const std::string &new_name)
Change the client name of the given client.
Definition: network_server.cpp:1653
NetworkClientPreferTeamChat
bool NetworkClientPreferTeamChat(const NetworkClientInfo *cio)
Tell whether the client has team members who they can chat to.
Definition: network_client.cpp:1373
NetworkServerKickOrBanIP
uint NetworkServerKickOrBanIP(ClientID client_id, bool ban, const std::string &reason)
Ban, or kick, everyone joined from the given client's IP.
Definition: network_server.cpp:2042
NetworkAddChatMessage
void CDECL NetworkAddChatMessage(TextColour colour, uint duration, const std::string &message)
Add a text message to the 'chat window' to be shown.
Definition: network_chat_gui.cpp:86
PauseMode
PauseMode
Modes of pausing we've got.
Definition: openttd.h:68
NetworkMaxCompaniesReached
bool NetworkMaxCompaniesReached()
Check if max_companies has been reached on the server (local check only).
Definition: network_client.cpp:1398
_network_host_list
StringList _network_host_list
The servers we know.
Definition: network.cpp:74
NetworkBackgroundLoop
void NetworkBackgroundLoop()
We have to do some (simple) background stuff that runs normally, even when we are not in multiplayer.
Definition: network.cpp:1082
NetworkUpdateClientName
void NetworkUpdateClientName(const std::string &client_name)
Send the server our name as callback from the setting.
Definition: network_client.cpp:1334
NetworkServerSendConfigUpdate
void NetworkServerSendConfigUpdate()
Send Config Update.
Definition: network_server.cpp:1964
NetworkClientRequestMove
void NetworkClientRequestMove(CompanyID company)
Notify the server of this client wanting to be moved to another company.
Definition: network_client.cpp:1256
ClientID
ClientID
'Unique' identifier to be given to clients
Definition: network_type.h:49
NetworkUndrawChatMessage
void NetworkUndrawChatMessage()
Hide the chatbox.
Definition: network_chat_gui.cpp:121
NetworkValidateClientName
bool NetworkValidateClientName(std::string &client_name)
Trim the given client name in place, i.e.
Definition: network_client.cpp:1309
NetworkValidateOurClientName
bool NetworkValidateOurClientName()
Convenience method for NetworkValidateClientName on _settings_client.network.client_name.
Definition: network_client.cpp:1325
NetworkServerNewCompany
void NetworkServerNewCompany(const Company *company, NetworkClientInfo *ci)
Perform all the server specific administration of a new company.
Definition: network_server.cpp:2151
NetworkServerSendExternalChat
void NetworkServerSendExternalChat(const std::string &source, TextColour colour, const std::string &user, const std::string &msg)
Send a chat message from external source.
Definition: network_server.cpp:1376
NetworkServerSendRcon
void NetworkServerSendRcon(ClientID client_id, TextColour colour_code, const std::string &string)
Send an rcon reply to the client.
Definition: network_server.cpp:2020
_network_own_client_id
ClientID _network_own_client_id
Uncomment the following define to enable command replaying.
Definition: network.cpp:70
NetworkClientsToSpectators
void NetworkClientsToSpectators(CompanyID cid)
Move the clients of a company to the spectators.
Definition: network_client.cpp:1265
_network_ban_list
StringList _network_ban_list
The banned clients.
Definition: network.cpp:75
NetworkReInitChatBoxSize
void NetworkReInitChatBoxSize()
Initialize all font-dependent chat box sizes.
Definition: network_chat_gui.cpp:102
NetworkAfterNewGRFScan
void NetworkAfterNewGRFScan()
Rebuild the GRFConfig's of the servers in the game list as we did a rescan and might have found new N...
Definition: network_gamelist.cpp:118
_network_reconnect
uint8_t _network_reconnect
Reconnect timeout.
Definition: network.cpp:72
NetworkServerKickClient
void NetworkServerKickClient(ClientID client_id, const std::string &reason)
Kick a single client.
Definition: network_server.cpp:2030
_redirect_console_to_client
ClientID _redirect_console_to_client
If not invalid, redirect the console output to a client.
Definition: network.cpp:71
Company
Definition: company_base.h:133
NetworkServerUpdateGameInfo
void NetworkServerUpdateGameInfo()
Update the server's NetworkServerGameInfo due to changes in settings.
Definition: network_server.cpp:1972
NetworkOnGameStart
void NetworkOnGameStart()
Perform tasks when the server is started.
Definition: network.cpp:947
NetworkClientInfo
Container for all information known about a client.
Definition: network_base.h:24
NetworkValidateServerName
bool NetworkValidateServerName(std::string &server_name)
Trim the given server name in place, i.e.
Definition: network.cpp:860
network_type.h
NetworkInitChatMessage
void NetworkInitChatMessage()
Initialize all buffers of the chat visualisation.
Definition: network_chat_gui.cpp:109