1

/* $Id$ */

     2

     3

/** @file network_internal.h Variables and function used internally. */

     4

     5

#ifndef NETWORK_INTERNAL_H

     6

#define NETWORK_INTERNAL_H

     7

     8

#ifdef ENABLE_NETWORK

     9

    10

#include "network.h"

    11

#include "network_func.h"

    12

#include "core/os_abstraction.h"

    13

#include "core/core.h"

    14

#include "core/config.h"

    15

#include "core/packet.h"

    16

#include "core/tcp.h"

    17

    18

/**

    19

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

    20

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

    21

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

    22

 *  game.

    23

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

    24

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

    25

 *  nothing will happen.

    26

 */

    27

//#define ENABLE_NETWORK_SYNC_EVERY_FRAME

    28

    29

/**

    30

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

    31

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

    32

 */

    33

//#define NETWORK_SEND_DOUBLE_SEED

    34

    35

enum MapPacket {

    36

	MAP_PACKET_START,

    37

	MAP_PACKET_NORMAL,

    38

	MAP_PACKET_END,

    39

};

    40

    41

    42

enum NetworkJoinStatus {

    43

	NETWORK_JOIN_STATUS_CONNECTING,

    44

	NETWORK_JOIN_STATUS_AUTHORIZING,

    45

	NETWORK_JOIN_STATUS_WAITING,

    46

	NETWORK_JOIN_STATUS_DOWNLOADING,

    47

	NETWORK_JOIN_STATUS_PROCESSING,

    48

	NETWORK_JOIN_STATUS_REGISTERING,

    49

    50

	NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO,

    51

};

    52

    53

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

    54

enum NetworkLanguage {

    55

	NETLANG_ANY = 0,

    56

	NETLANG_ENGLISH,

    57

	NETLANG_GERMAN,

    58

	NETLANG_FRENCH,

    59

	NETLANG_BRAZILIAN,

    60

	NETLANG_BULGARIAN,

    61

	NETLANG_CHINESE,

    62

	NETLANG_CZECH,

    63

	NETLANG_DANISH,

    64

	NETLANG_DUTCH,

    65

	NETLANG_ESPERANTO,

    66

	NETLANG_FINNISH,

    67

	NETLANG_HUNGARIAN,

    68

	NETLANG_ICELANDIC,

    69

	NETLANG_ITALIAN,

    70

	NETLANG_JAPANESE,

    71

	NETLANG_KOREAN,

    72

	NETLANG_LITHUANIAN,

    73

	NETLANG_NORWEGIAN,

    74

	NETLANG_POLISH,

    75

	NETLANG_PORTUGUESE,

    76

	NETLANG_ROMANIAN,

    77

	NETLANG_RUSSIAN,

    78

	NETLANG_SLOVAK,

    79

	NETLANG_SLOVENIAN,

    80

	NETLANG_SPANISH,

    81

	NETLANG_SWEDISH,

    82

	NETLANG_TURKISH,

    83

	NETLANG_UKRAINIAN,

    84

	NETLANG_AFRIKAANS,

    85

	NETLANG_CROATIAN,

    86

	NETLANG_CATALAN,

    87

	NETLANG_ESTONIAN,

    88

	NETLANG_GALICIAN,

    89

	NETLANG_GREEK,

    90

	NETLANG_LATVIAN,

    91

	NETLANG_COUNT

    92

};

    93

    95

    96

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

    97

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

    98

    99

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

   100

   101

// networking settings

   102

extern uint32 _broadcast_list[MAX_INTERFACES + 1];

   103

   104

extern uint32 _network_server_bind_ip;

   105

   106

extern uint32 _sync_seed_1, _sync_seed_2;

   107

extern uint32 _sync_frame;

   108

extern bool _network_first_time;

   109

// Vars needed for the join-GUI

   110

extern NetworkJoinStatus _network_join_status;

   111

extern uint8 _network_join_waiting;

   112

extern uint16 _network_join_kbytes;

   113

extern uint16 _network_join_kbytes_total;

   114

   115

extern uint32 _network_last_host_ip;

   116

extern uint8 _network_reconnect;

   117

   118

extern bool _network_udp_server;

   119

extern uint16 _network_udp_broadcast;

   120

   121

extern uint8 _network_advertise_retries;

   122

   123

// following externs are instantiated at network.cpp

   124

extern CommandPacket *_local_command_queue;

   125

   126

// Here we keep track of the clients

   127

//  (and the client uses [0] for his own communication)

   128

extern NetworkTCPSocketHandler _clients[MAX_CLIENTS];

   129

   130

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

   131

   132

void NetworkAddServer(const char *b);

   133

void NetworkRebuildHostList();

   134

void UpdateNetworkGameWindow(bool unselect);

   135

   136

bool IsNetworkCompatibleVersion(const char *version);

   137

   138

void NetworkExecuteCommand(CommandPacket *cp);

   139

void NetworkAddCommandQueue(NetworkTCPSocketHandler *cs, CommandPacket *cp);

   140

   141

// from network.c

   142

void NetworkCloseClient(NetworkTCPSocketHandler *cs);

   143

void CDECL NetworkTextMessage(NetworkAction action, ConsoleColour color, bool self_send, const char *name, const char *str, ...);

   144

void NetworkGetClientName(char *clientname, size_t size, const NetworkTCPSocketHandler *cs);

   145

uint NetworkCalculateLag(const NetworkTCPSocketHandler *cs);

   146

byte NetworkGetCurrentLanguageIndex();

   147

NetworkTCPSocketHandler *NetworkFindClientStateFromIndex(uint16 client_index);

   148

char* GetNetworkErrorMsg(char* buf, NetworkErrorCode err, const char* last);

   149

bool NetworkFindName(char new_name[NETWORK_CLIENT_NAME_LENGTH]);

   150

   151

#define DEREF_CLIENT(i) (&_clients[i])

   152

// This returns the NetworkClientInfo from a NetworkClientState

   153

#define DEREF_CLIENT_INFO(cs) (&_network_client_info[cs - _clients])

   154

   155

// Macros to make life a bit more easier

   156

#define DEF_CLIENT_RECEIVE_COMMAND(type) NetworkRecvStatus NetworkPacketReceive_ ## type ## _command(Packet *p)

   157

#define DEF_CLIENT_SEND_COMMAND(type) void NetworkPacketSend_ ## type ## _command()

   158

#define DEF_CLIENT_SEND_COMMAND_PARAM(type) void NetworkPacketSend_ ## type ## _command

   159

#define DEF_SERVER_RECEIVE_COMMAND(type) void NetworkPacketReceive_ ## type ## _command(NetworkTCPSocketHandler *cs, Packet *p)

   160

#define DEF_SERVER_SEND_COMMAND(type) void NetworkPacketSend_ ## type ## _command(NetworkTCPSocketHandler *cs)

   161

#define DEF_SERVER_SEND_COMMAND_PARAM(type) void NetworkPacketSend_ ## type ## _command

   162

   163

#define SEND_COMMAND(type) NetworkPacketSend_ ## type ## _command

   164

#define RECEIVE_COMMAND(type) NetworkPacketReceive_ ## type ## _command

   165

   166

#define FOR_ALL_CLIENTS(cs) for (cs = _clients; cs != endof(_clients) && cs->IsConnected(); cs++)

   167

   168

#endif /* ENABLE_NETWORK */

   169

#endif /* NETWORK_INTERNAL_H */