1

/* $Id$ */

     2

     3

#ifndef NETWORK_H

     4

#define NETWORK_H

     5

     6

#ifdef ENABLE_NETWORK

     7

     8

#include "../player.h"

     9

#include "core/config.h"

    10

#include "core/game.h"

    11

    12

// If this line is enable, every frame will have a sync test

    13

//  this is not needed in normal games. Normal is like 1 sync in 100

    14

//  frames. You can enable this if you have a lot of desyncs on a certain

    15

//  game.

    16

// Remember: both client and server have to be compiled with this

    17

//  option enabled to make it to work. If one of the two has it disabled

    18

//  nothing will happen.

    19

//#define ENABLE_NETWORK_SYNC_EVERY_FRAME

    20

    21

/*

    22

 * Dumps all commands that are sent/received to stderr and saves every month.

    23

 * This log can become quite large over time; say in the order of two to three

    24

 * times the bandwidth used for network games.

    25

 */

    26

//#define DEBUG_DUMP_COMMANDS

    27

    28

#ifdef DEBUG_DUMP_COMMANDS

    29

void CDECL debug_dump_commands(const char *s, ...);

    30

#endif /* DEBUG_DUMP_COMMANDS */

    31

    32

// In theory sending 1 of the 2 seeds is enough to check for desyncs

    33

//   so in theory, this next define can be left off.

    34

//#define NETWORK_SEND_DOUBLE_SEED

    35

    36

// How many clients can we have? Like.. MAX_PLAYERS - 1 is the amount of

    37

//  players that can really play.. so.. a max of 4 spectators.. gives us..

    38

//  MAX_PLAYERS + 3

    39

#define MAX_CLIENTS (MAX_PLAYERS + 3)

    40

    41

    42

// Do not change this next line. It should _ALWAYS_ be MAX_CLIENTS + 1

    43

#define MAX_CLIENT_INFO (MAX_CLIENTS + 1)

    44

    45

#define MAX_INTERFACES 9

    46

    47

    48

// How many vehicle/station types we put over the network

    49

#define NETWORK_VEHICLE_TYPES 5

    50

#define NETWORK_STATION_TYPES 5

    51

    52

struct NetworkPlayerInfo {

    53

	char company_name[NETWORK_NAME_LENGTH];         // Company name

    54

	char password[NETWORK_PASSWORD_LENGTH];         // The password for the player

    55

	Year inaugurated_year;                          // What year the company started in

    56

	Money company_value;                            // The company value

    57

	Money money;                                    // The amount of money the company has

    58

	Money income;                                   // How much did the company earned last year

    59

	uint16 performance;                             // What was his performance last month?

    60

	bool use_password;                              // Is there a password

    61

	uint16 num_vehicle[NETWORK_VEHICLE_TYPES];      // How many vehicles are there of this type?

    62

	uint16 num_station[NETWORK_STATION_TYPES];      // How many stations are there of this type?

    63

	char players[NETWORK_PLAYERS_LENGTH];           // The players that control this company (Name1, name2, ..)

    64

	uint16 months_empty;                            // How many months the company is empty

    65

};

    66

    67

struct NetworkClientInfo {

    68

	uint16 client_index;                            // Index of the client (same as ClientState->index)

    69

	char client_name[NETWORK_CLIENT_NAME_LENGTH];   // Name of the client

    70

	byte client_lang;                               // The language of the client

    71

	PlayerID client_playas;                         // As which player is this client playing (PlayerID)

    72

	uint32 client_ip;                               // IP-address of the client (so he can be banned)

    73

	Date join_date;                                 // Gamedate the player has joined

    74

	char unique_id[NETWORK_UNIQUE_ID_LENGTH];       // Every play sends an unique id so we can indentify him

    75

};

    76

    77

enum NetworkJoinStatus {

    78

	NETWORK_JOIN_STATUS_CONNECTING,

    79

	NETWORK_JOIN_STATUS_AUTHORIZING,

    80

	NETWORK_JOIN_STATUS_WAITING,

    81

	NETWORK_JOIN_STATUS_DOWNLOADING,

    82

	NETWORK_JOIN_STATUS_PROCESSING,

    83

	NETWORK_JOIN_STATUS_REGISTERING,

    84

    85

	NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO,

    86

};

    87

    88

/* Language ids for server_lang and client_lang. Do NOT modify the order. */

    89

enum NetworkLanguage {

    90

	NETLANG_ANY = 0,

    91

	NETLANG_ENGLISH,

    92

	NETLANG_GERMAN,

    93

	NETLANG_FRENCH,

    94

	NETLANG_BRAZILIAN,

    95

	NETLANG_BULGARIAN,

    96

	NETLANG_CHINESE,

    97

	NETLANG_CZECH,

    98

	NETLANG_DANISH,

    99

	NETLANG_DUTCH,

   100

	NETLANG_ESPERANTO,

   101

	NETLANG_FINNISH,

   102

	NETLANG_HUNGARIAN,

   103

	NETLANG_ICELANDIC,

   104

	NETLANG_ITALIAN,

   105

	NETLANG_JAPANESE,

   106

	NETLANG_KOREAN,

   107

	NETLANG_LITHUANIAN,

   108

	NETLANG_NORWEGIAN,

   109

	NETLANG_POLISH,

   110

	NETLANG_PORTUGUESE,

   111

	NETLANG_ROMANIAN,

   112

	NETLANG_RUSSIAN,

   113

	NETLANG_SLOVAK,

   114

	NETLANG_SLOVENIAN,

   115

	NETLANG_SPANISH,

   116

	NETLANG_SWEDISH,

   117

	NETLANG_TURKISH,

   118

	NETLANG_UKRAINIAN,

   119

	NETLANG_COUNT

   120

};

   121

   122

VARDEF NetworkGameInfo _network_game_info;

   123

VARDEF NetworkPlayerInfo _network_player_info[MAX_PLAYERS];

   124

VARDEF NetworkClientInfo _network_client_info[MAX_CLIENT_INFO];

   125

   126

VARDEF char _network_player_name[NETWORK_CLIENT_NAME_LENGTH];

   127

VARDEF char _network_default_ip[NETWORK_HOSTNAME_LENGTH];

   128

   129

VARDEF uint16 _network_own_client_index;

   130

VARDEF char _network_unique_id[NETWORK_UNIQUE_ID_LENGTH]; // Our own unique ID

   131

   132

VARDEF uint32 _frame_counter_server; // The frame_counter of the server, if in network-mode

   133

VARDEF uint32 _frame_counter_max; // To where we may go with our clients

   134

   135

VARDEF uint32 _last_sync_frame; // Used in the server to store the last time a sync packet was sent to clients.

   136

   137

// networking settings

   138

VARDEF uint32 _broadcast_list[MAX_INTERFACES + 1];

   139

   140

VARDEF uint16 _network_server_port;

   141

/* We use bind_ip and bind_ip_host, where bind_ip_host is the readable form of

   142

    bind_ip_host, and bind_ip the numeric value, because we want a nice number

   143

    in the openttd.cfg, but we wants to use the uint32 internally.. */

   144

VARDEF uint32 _network_server_bind_ip;

   145

VARDEF char _network_server_bind_ip_host[NETWORK_HOSTNAME_LENGTH];

   146

VARDEF bool _is_network_server; // Does this client wants to be a network-server?

   147

VARDEF char _network_server_name[NETWORK_NAME_LENGTH];

   148

VARDEF char _network_server_password[NETWORK_PASSWORD_LENGTH];

   149

VARDEF char _network_rcon_password[NETWORK_PASSWORD_LENGTH];

   150

VARDEF char _network_default_company_pass[NETWORK_PASSWORD_LENGTH];

   151

   152

VARDEF uint16 _network_max_join_time;             ///< Time a client can max take to join

   153

VARDEF bool _network_pause_on_join;               ///< Pause the game when a client tries to join (more chance of succeeding join)

   154

   155

VARDEF uint16 _redirect_console_to_client;

   156

   157

VARDEF uint16 _network_sync_freq;

   158

VARDEF uint8 _network_frame_freq;

   159

   160

VARDEF uint32 _sync_seed_1, _sync_seed_2;

   161

VARDEF uint32 _sync_frame;

   162

VARDEF bool _network_first_time;

   163

// Vars needed for the join-GUI

   164

VARDEF NetworkJoinStatus _network_join_status;

   165

VARDEF uint8 _network_join_waiting;

   166

VARDEF uint16 _network_join_kbytes;

   167

VARDEF uint16 _network_join_kbytes_total;

   168

   169

VARDEF char _network_last_host[NETWORK_HOSTNAME_LENGTH];

   170

VARDEF short _network_last_port;

   171

VARDEF uint32 _network_last_host_ip;

   172

VARDEF uint8 _network_reconnect;

   173

   174

VARDEF bool _network_udp_server;

   175

VARDEF uint16 _network_udp_broadcast;

   176

   177

VARDEF byte _network_lan_internet;

   178

   179

VARDEF bool _network_need_advertise;

   180

VARDEF uint32 _network_last_advertise_frame;

   181

VARDEF uint8 _network_advertise_retries;

   182

   183

VARDEF bool _network_autoclean_companies;

   184

VARDEF uint8 _network_autoclean_unprotected; // Remove a company after X months

   185

VARDEF uint8 _network_autoclean_protected;   // Unprotect a company after X months

   186

   187

VARDEF Year _network_restart_game_year;      // If this year is reached, the server automaticly restarts

   188

VARDEF uint8 _network_min_players;           // Minimum number of players for game to unpause

   189

   190

void NetworkTCPQueryServer(const char* host, unsigned short port);

   191

   192

byte NetworkSpectatorCount();

   193

   194

VARDEF char *_network_host_list[10];

   195

VARDEF char *_network_ban_list[25];

   196

   197

void ParseConnectionString(const char **player, const char **port, char *connection_string);

   198

void NetworkUpdateClientInfo(uint16 client_index);

   199

void NetworkAddServer(const char *b);

   200

void NetworkRebuildHostList();

   201

bool NetworkChangeCompanyPassword(byte argc, char *argv[]);

   202

void NetworkPopulateCompanyInfo();

   203

void UpdateNetworkGameWindow(bool unselect);

   204

void CheckMinPlayers();

   205

void NetworkStartDebugLog(const char *hostname, uint16 port);

   206

   207

void NetworkStartUp();

   208

void NetworkUDPCloseAll();

   209

void NetworkShutDown();

   210

void NetworkGameLoop();

   211

void NetworkUDPGameLoop();

   212

bool NetworkServerStart();

   213

bool NetworkClientConnectGame(const char *host, uint16 port);

   214

void NetworkReboot();

   215

void NetworkDisconnect();

   216

   217

bool IsNetworkCompatibleVersion(const char *version);

   218

   219

extern bool _networking;         ///< are we in networking mode?

   220

VARDEF bool _network_server;     ///< network-server is active

   221

VARDEF bool _network_available;  ///< is network mode available?

   222

VARDEF bool _network_dedicated;  ///< are we a dedicated server?

   223

VARDEF bool _network_advertise;  ///< is the server advertising to the master server?

   224

   225

#else /* ENABLE_NETWORK */

   226

/* Network function stubs when networking is disabled */

   227

   228

static inline void NetworkStartUp() {}

   229

static inline void NetworkShutDown() {}

   230

   231

#define _networking 0

   232

#define _network_server 0

   233

#define _network_available 0

   234

#define _network_dedicated 0

   235

#define _network_advertise 0

   236

   237

#endif /* ENABLE_NETWORK */

   238

   239

/* This variable must always be registered! */

   240

VARDEF PlayerID _network_playas; ///< an id to play as.. (see players.h:Players)

   241

   242

#endif /* NETWORK_H */