1

#ifndef NETWORK_H

     2

#define NETWORK_H

     3

     4

#include "network_core.h"

     5

#define NOREV_STRING "norev000"

     6

     7

#ifdef ENABLE_NETWORK

     8

     9

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

    10

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

    11

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

    12

//  game.

    13

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

    14

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

    15

//  nothing will happen.

    16

//#define ENABLE_NETWORK_SYNC_EVERY_FRAME

    17

    18

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

    19

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

    20

//#define NETWORK_SEND_DOUBLE_SEED

    21

    22

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

    23

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

    24

//  MAX_PLAYERS + 3

    25

#define MAX_CLIENTS (MAX_PLAYERS + 3)

    26

    27

    28

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

    29

#define MAX_CLIENT_INFO (MAX_CLIENTS + 1)

    30

    36

#define NETWORK_DEFAULT_PORT 3979

    37

    38

#define MAX_INTERFACES 9

    39

    40

    41

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

    42

#define NETWORK_VEHICLE_TYPES 5

    43

#define NETWORK_STATION_TYPES 5

    44

    45

#define NETWORK_NAME_LENGTH 80

    46

#define NETWORK_HOSTNAME_LENGTH 80

    47

#define NETWORK_REVISION_LENGTH 10

    48

#define NETWORK_PASSWORD_LENGTH 20

    49

#define NETWORK_PLAYERS_LENGTH 200

    50

    51

// This is the struct used by both client and server

    52

//  some fields will be empty on the client (like game_password) by default

    53

//  and only filled with data a player enters.

    54

typedef struct NetworkGameInfo {

    55

	char server_name[NETWORK_NAME_LENGTH];					// Server name

    56

	char hostname[NETWORK_HOSTNAME_LENGTH];					// Hostname of the server (if any)

    57

	char server_revision[NETWORK_REVISION_LENGTH];	// The SVN version number the server is using (e.g.: 'r304')

    58

																									//  It even shows a SVN version in release-version, so

    59

																									//  it is easy to compare if a server is of the correct version

    60

	byte server_lang;																// Language of the server (we should make a nice table for this)

    61

	byte use_password;															// Is set to != 0 if it uses a password

    62

	char server_password[NETWORK_PASSWORD_LENGTH];	// On the server: the game password, on the client: != "" if server has password

    63

	byte clients_max;																// Max clients allowed on server

    64

	byte clients_on;																// Current count of clients on server

    65

	byte spectators_on;															// How many spectators do we have?

    66

	uint16 game_date;																// Current date

    67

	uint16 start_date;															// When the game started

    68

	char map_name[NETWORK_NAME_LENGTH];							// Map which is played ["random" for a randomized map]

    69

	uint16 map_width;																// Map width

    70

	uint16 map_height;															// Map height

    71

	byte map_set;																		// Graphical set

    72

	bool dedicated;																	// Is this a dedicated server?

    73

} NetworkGameInfo;

    74

    75

typedef struct NetworkPlayerInfo {

    76

	char company_name[NETWORK_NAME_LENGTH];					// Company name

    77

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

    78

	byte inaugurated_year;													// What year the company started in

    79

	int64 company_value;														// The company value

    80

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

    81

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

    82

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

    83

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

    84

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

    85

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

    86

} NetworkPlayerInfo;

    87

    88

typedef struct NetworkClientInfo {

    89

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

    90

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

    91

	byte client_lang;																// The language of the client

    92

	byte client_playas;															// As which player is this client playing

    93

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

    94

	uint16 join_date;																// Gamedate the player has joined

    95

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

    96

} NetworkClientInfo;

    97

    98

typedef struct NetworkGameList {

    99

	NetworkGameInfo info;

   100

	uint32 ip;

   101

	uint16 port;

   102

	bool online;																		// False if the server did not respond (default status)

   103

	struct NetworkGameList *next;

   104

} NetworkGameList;

   105

   106

typedef enum {

   107

	NETWORK_JOIN_STATUS_CONNECTING,

   108

	NETWORK_JOIN_STATUS_AUTHORIZING,

   109

	NETWORK_JOIN_STATUS_WAITING,

   110

	NETWORK_JOIN_STATUS_DOWNLOADING,

   111

	NETWORK_JOIN_STATUS_PROCESSING,

   112

   113

	NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO,

   114

} NetworkJoinStatus;

   115

   116

// language ids for server_lang and client_lang

   117

typedef enum {

   118

	NETLANG_ANY = 0,

   119

	NETLANG_ENGLISH = 1,

   120

	NETLANG_GERMAN = 2,

   121

	NETLANG_FRENCH = 3,

   122

} NetworkLanguage;

   123

   124

VARDEF NetworkGameList *_network_game_list;

   125

   126

VARDEF NetworkGameInfo _network_game_info;

   127

VARDEF NetworkPlayerInfo _network_player_info[MAX_PLAYERS];

   128

VARDEF NetworkClientInfo _network_client_info[MAX_CLIENT_INFO];

   129

   130

VARDEF char _network_player_name[NETWORK_NAME_LENGTH];

   131

VARDEF char _network_default_ip[NETWORK_HOSTNAME_LENGTH];

   132

   133

VARDEF uint16 _network_own_client_index;

   134

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

   135

   136

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

   137

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

   138

   139

// networking settings

   140

VARDEF uint32 _network_ip_list[MAX_INTERFACES + 1]; // Network IPs

   141

VARDEF uint16 _network_game_count;

   142

   143

VARDEF uint16 _network_lobby_company_count;

   144

   145

VARDEF uint _network_server_port;

   146

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

   147

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

   148

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

   149

VARDEF uint32 _network_server_bind_ip;

   150

VARDEF char _network_server_bind_ip_host[NETWORK_HOSTNAME_LENGTH];

   151

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

   152

VARDEF char _network_server_name[NETWORK_NAME_LENGTH];

   153

   154

VARDEF uint16 _network_sync_freq;

   155

VARDEF uint8 _network_frame_freq;

   156

   157

VARDEF uint32 _sync_seed_1, _sync_seed_2;

   158

VARDEF uint32 _sync_frame;

   159

VARDEF bool _network_first_time;

   160

// Vars needed for the join-GUI

   161

VARDEF NetworkJoinStatus _network_join_status;

   162

VARDEF uint8 _network_join_waiting;

   163

VARDEF uint16 _network_join_kbytes;

   164

VARDEF uint16 _network_join_kbytes_total;

   165

   166

VARDEF char _network_last_host[NETWORK_HOSTNAME_LENGTH];

   167

VARDEF short _network_last_port;

   168

VARDEF uint32 _network_last_host_ip;

   169

VARDEF uint8 _network_reconnect;

   170

   171

VARDEF bool _network_udp_server;

   172

VARDEF uint16 _network_udp_broadcast;

   173

   177

#endif /* ENABLE_NETWORK */

   178

   179

// Those variables must always be registered!

   180

VARDEF bool _networking;

   181

VARDEF bool _network_available;  // is network mode available?

   182

VARDEF bool _network_server; // network-server is active

   183

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

   184

VARDEF byte _network_playas; // an id to play as..

   185

   186

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

   187

void NetworkUpdateClientInfo(uint16 client_index);

   188

   189

#endif /* NETWORK_H */