network_internal.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#ifndef NETWORK_INTERNAL_H
#define NETWORK_INTERNAL_H
 
#include "network_func.h"
#include "core/tcp_coordinator.h"
#include "core/tcp_game.h"
 
#include "../command_type.h"
#include "../command_func.h"
#include "../misc/endian_buffer.hpp"
 
#ifdef RANDOM_DEBUG
 
#define ENABLE_NETWORK_SYNC_EVERY_FRAME
 
#define NETWORK_SEND_DOUBLE_SEED
#endif /* RANDOM_DEBUG */
 
#ifdef DEBUG_DUMP_COMMANDS
extern bool _ddc_fastforward;
#else
#define _ddc_fastforward (false)
#endif /* DEBUG_DUMP_COMMANDS */
 
typedef class ServerNetworkGameSocketHandler NetworkClientSocket;
 
enum NetworkJoinStatus {
  NETWORK_JOIN_STATUS_CONNECTING,
  NETWORK_JOIN_STATUS_AUTHORIZING,
  NETWORK_JOIN_STATUS_WAITING,
  NETWORK_JOIN_STATUS_DOWNLOADING,
  NETWORK_JOIN_STATUS_PROCESSING,
  NETWORK_JOIN_STATUS_REGISTERING,
 
  NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO,
  NETWORK_JOIN_STATUS_END,
};
 
extern uint32 _frame_counter_server; // The frame_counter of the server, if in network-mode
extern uint32 _frame_counter_max; // To where we may go with our clients
extern uint32 _frame_counter;
 
extern uint32 _last_sync_frame; // Used in the server to store the last time a sync packet was sent to clients.
 
/* networking settings */
extern NetworkAddressList _broadcast_list;
 
extern uint32 _sync_seed_1;
#ifdef NETWORK_SEND_DOUBLE_SEED
extern uint32 _sync_seed_2;
#endif
extern uint32 _sync_frame;
extern bool _network_first_time;
/* Vars needed for the join-GUI */
extern NetworkJoinStatus _network_join_status;
extern uint8 _network_join_waiting;
extern uint32 _network_join_bytes;
extern uint32 _network_join_bytes_total;
extern ConnectionType _network_server_connection_type;
extern std::string _network_server_invite_code;
 
/* Variable available for clients. */
extern std::string _network_server_name;
 
extern uint8 _network_reconnect;
 
extern CompanyMask _network_company_passworded;
 
void NetworkQueryServer(const std::string &connection_string);
 
void GetBindAddresses(NetworkAddressList *addresses, uint16 port);
struct NetworkGameList *NetworkAddServer(const std::string &connection_string, bool manually = true, bool never_expire = false);
void NetworkRebuildHostList();
void UpdateNetworkGameWindow();
 
/* From network_command.cpp */
struct CommandPacket {
  CommandPacket() : next(nullptr), company(INVALID_COMPANY), frame(0), my_cmd(false) {}
  CommandPacket *next; 
  CompanyID company;   
  uint32 frame;        
  bool my_cmd;         
 
  Commands cmd;              
  StringID err_msg;          
  CommandCallback *callback; 
  CommandDataBuffer data;    
};
 
void NetworkDistributeCommands();
void NetworkExecuteLocalCommandQueue();
void NetworkFreeLocalCommandQueue();
void NetworkSyncCommandQueue(NetworkClientSocket *cs);
void NetworkReplaceCommandClientId(CommandPacket &cp, ClientID client_id);
 
void ShowNetworkError(StringID error_string);
void NetworkTextMessage(NetworkAction action, TextColour colour, bool self_send, const std::string &name, const std::string &str = "", int64 data = 0, const std::string &data_str = "");
uint NetworkCalculateLag(const NetworkClientSocket *cs);
StringID GetNetworkErrorMsg(NetworkErrorCode err);
bool NetworkMakeClientNameUnique(std::string &new_name);
std::string GenerateCompanyPasswordHash(const std::string &password, const std::string &password_server_id, uint32 password_game_seed);
 
std::string_view ParseCompanyFromConnectionString(const std::string &connection_string, CompanyID *company_id);
NetworkAddress ParseConnectionString(const std::string &connection_string, uint16 default_port);
std::string NormalizeConnectionString(const std::string &connection_string, uint16 default_port);
 
#endif /* NETWORK_INTERNAL_H */