1

#ifndef NETWORK_DATA_H

     2

#define NETWORK_DATA_H

     3

     5

#include "network.h"

     6

#include "network_core.h"

     7

     8

// Is the network enabled?

     9

#ifdef ENABLE_NETWORK

    10

    11

#define SEND_MTU 1460

    12

#define MAX_TEXT_MSG_LEN 1024 /* long long long long sentences :-) */

    13

    14

// The client-info-server-index is always 1

    15

#define NETWORK_SERVER_INDEX 1

    16

#define NETWORK_EMPTY_INDEX 0

    17

    18

// What version of game-info do we use?

    19

#define NETWORK_GAME_INFO_VERSION 1

    20

// What version of company info is this?

    21

#define NETWORK_COMPANY_INFO_VERSION 3

    22

// What version of master-server-protocol do we use?

    23

#define NETWORK_MASTER_SERVER_VERSION 1

    24

    25

typedef uint16 PacketSize;

    26

    27

typedef struct Packet {

    28

	struct Packet *next;

    29

	PacketSize size;

    30

	PacketSize pos;

    31

	byte buffer[SEND_MTU];

    32

} Packet;

    33

    34

typedef struct CommandPacket {

    35

	struct CommandPacket *next;

    36

	byte player;   /// player that is executing the command (PlayerID)

    37

	uint32 cmd;    /// command being executed

    38

	uint32 p1;     /// parameter p1

    39

	uint32 p2;     /// parameter p2

    40

	uint32 tile;   /// tile command being executed on ; always make it uint32, so it is bigmap compatible (TileIndex)

    41

	char text[80];

    42

	uint32 frame;  /// the frame in which this packet is executed

    43

	byte callback; /// any callback function executed upon successful completion of the command

    44

} CommandPacket;

    45

    46

typedef enum {

    47

	STATUS_INACTIVE,

    48

	STATUS_AUTH, // This means that the client is authorized

    49

	STATUS_MAP_WAIT, // This means that the client is put on hold because someone else is getting the map

    50

	STATUS_MAP,

    51

	STATUS_DONE_MAP,

    52

	STATUS_PRE_ACTIVE,

    53

	STATUS_ACTIVE,

    54

} ClientStatus;

    55

    56

typedef enum {

    57

	MAP_PACKET_START,

    58

	MAP_PACKET_NORMAL,

    59

	MAP_PACKET_PATCH,

    60

	MAP_PACKET_END,

    61

} MapPacket;

    62

    63

typedef enum {

    64

	NETWORK_RECV_STATUS_OKAY,

    65

	NETWORK_RECV_STATUS_DESYNC,

    66

	NETWORK_RECV_STATUS_SAVEGAME,

    67

	NETWORK_RECV_STATUS_CONN_LOST,

    68

	NETWORK_RECV_STATUS_MALFORMED_PACKET,

    69

	NETWORK_RECV_STATUS_SERVER_ERROR, // The server told us we made an error

    70

	NETWORK_RECV_STATUS_SERVER_FULL,

    71

	NETWORK_RECV_STATUS_SERVER_BANNED,

    72

	NETWORK_RECV_STATUS_CLOSE_QUERY, // Done quering the server

    73

} NetworkRecvStatus;

    74

    75

typedef enum {

    76

	NETWORK_ERROR_GENERAL, // Try to use thisone like never

    77

    78

	// Signals from clients

    79

	NETWORK_ERROR_DESYNC,

    80

	NETWORK_ERROR_SAVEGAME_FAILED,

    81

	NETWORK_ERROR_CONNECTION_LOST,

    82

	NETWORK_ERROR_ILLEGAL_PACKET,

    83

    84

	// Signals from servers

    85

	NETWORK_ERROR_NOT_AUTHORIZED,

    86

	NETWORK_ERROR_NOT_EXPECTED,

    87

	NETWORK_ERROR_WRONG_REVISION,

    88

	NETWORK_ERROR_NAME_IN_USE,

    89

	NETWORK_ERROR_WRONG_PASSWORD,

    90

	NETWORK_ERROR_PLAYER_MISMATCH, // Happens in CLIENT_COMMAND

    91

	NETWORK_ERROR_KICKED,

    92

	NETWORK_ERROR_CHEATER,

    93

} NetworkErrorCode;

    94

    95

// Actions that can be used for NetworkTextMessage

    96

typedef enum {

    97

	NETWORK_ACTION_JOIN,

    98

	NETWORK_ACTION_LEAVE,

    99

	NETWORK_ACTION_CHAT,

   100

	NETWORK_ACTION_CHAT_PLAYER,

   101

	NETWORK_ACTION_CHAT_CLIENT,

   102

	NETWORK_ACTION_GIVE_MONEY,

   103

	NETWORK_ACTION_NAME_CHANGE,

   104

} NetworkAction;

   105

   106

typedef enum {

   107

	NETWORK_GAME_PASSWORD,

   108

	NETWORK_COMPANY_PASSWORD,

   109

} NetworkPasswordType;

   110

   111

// To keep the clients all together

   112

typedef struct NetworkClientState {

   113

	SOCKET socket;

   114

	uint16 index;

   115

	uint32 last_frame;

   116

	uint32 last_frame_server;

   117

	byte lag_test; // This byte is used for lag-testing the client

   118

   119

	ClientStatus status;

   120

	bool writable; // is client ready to write to?

   121

	bool quited;

   122

   123

	Packet *packet_queue; // Packets that are awaiting delivery

   124

	Packet *packet_recv; // Partially received packet

   125

   126

	CommandPacket *command_queue; // The command-queue awaiting delivery

   127

} NetworkClientState;

   128

   129

// What packet types are there

   130

// WARNING: The first 3 packets can NEVER change order again

   131

//   it protects old clients from joining newer servers (because SERVER_ERROR

   132

//   is the respond to a wrong revision)

   133

typedef enum {

   134

	PACKET_SERVER_FULL,

   135

	PACKET_SERVER_BANNED,

   136

	PACKET_CLIENT_JOIN,

   137

	PACKET_SERVER_ERROR,

   138

	PACKET_CLIENT_COMPANY_INFO,

   139

	PACKET_SERVER_COMPANY_INFO,

   140

	PACKET_SERVER_CLIENT_INFO,

   141

	PACKET_SERVER_NEED_PASSWORD,

   142

	PACKET_CLIENT_PASSWORD,

   143

	PACKET_SERVER_WELCOME,

   144

	PACKET_CLIENT_GETMAP,

   145

	PACKET_SERVER_WAIT,

   146

	PACKET_SERVER_MAP,

   147

	PACKET_CLIENT_MAP_OK,

   148

	PACKET_SERVER_JOIN,

   149

	PACKET_SERVER_FRAME,

   150

	PACKET_SERVER_SYNC,

   151

	PACKET_CLIENT_ACK,

   152

	PACKET_CLIENT_COMMAND,

   153

	PACKET_SERVER_COMMAND,

   154

	PACKET_CLIENT_CHAT,

   155

	PACKET_SERVER_CHAT,

   156

	PACKET_CLIENT_SET_PASSWORD,

   157

	PACKET_CLIENT_SET_NAME,

   158

	PACKET_CLIENT_QUIT,

   159

	PACKET_CLIENT_ERROR,

   160

	PACKET_SERVER_QUIT,

   161

	PACKET_SERVER_ERROR_QUIT,

   162

	PACKET_SERVER_SHUTDOWN,

   163

	PACKET_SERVER_NEWGAME,

   164

	PACKET_SERVER_RCON,

   165

	PACKET_CLIENT_RCON,

   166

	PACKET_END // Should ALWAYS be on the end of this list!! (period)

   167

} PacketType;

   168

   169

typedef enum {

   170

	DESTTYPE_BROADCAST,

   171

	DESTTYPE_PLAYER,

   172

	DESTTYPE_CLIENT

   173

} DestType;

   174

   175

CommandPacket *_local_command_queue;

   176

   177

SOCKET _udp_client_socket; // udp client socket

   178

SOCKET _udp_server_socket; // udp server socket

   179

SOCKET _udp_master_socket; // udp master socket

   180

   181

// Here we keep track of the clients

   182

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

   183

NetworkClientState _clients[MAX_CLIENTS];

   184

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

   185

// This returns the NetworkClientInfo from a NetworkClientState

   186

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

   187

   188

// Macros to make life a bit more easier

   189

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

   190

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

   191

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

   192

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

   193

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

   194

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

   195

   196

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

   197

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

   198

   199

#define FOR_ALL_CLIENTS(cs) for (cs = _clients; cs != &_clients[MAX_CLIENTS] && cs->socket != INVALID_SOCKET; cs++)

   200

   201

Packet *NetworkSend_Init(PacketType type);

   202

void NetworkSend_uint8(Packet *packet, uint8 data);

   203

void NetworkSend_uint16(Packet *packet, uint16 data);

   204

void NetworkSend_uint32(Packet *packet, uint32 data);

   205

void NetworkSend_uint64(Packet *packet, uint64 data);

   206

void NetworkSend_string(Packet *packet, const char* data);

   207

void NetworkSend_Packet(Packet *packet, NetworkClientState *cs);

   208

   209

uint8 NetworkRecv_uint8(NetworkClientState *cs, Packet *packet);

   210

uint16 NetworkRecv_uint16(NetworkClientState *cs, Packet *packet);

   211

uint32 NetworkRecv_uint32(NetworkClientState *cs, Packet *packet);

   212

uint64 NetworkRecv_uint64(NetworkClientState *cs, Packet *packet);

   213

void NetworkRecv_string(NetworkClientState *cs, Packet *packet, char* buffer, size_t size);

   214

Packet *NetworkRecv_Packet(NetworkClientState *cs, NetworkRecvStatus *status);

   215

   216

bool NetworkSend_Packets(NetworkClientState *cs);

   217

void NetworkExecuteCommand(CommandPacket *cp);

   218

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

   219

   220

// from network.c

   221

void NetworkCloseClient(NetworkClientState *cs);

   222

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

   223

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

   224

uint NetworkCalculateLag(const NetworkClientState *cs);

   225

byte NetworkGetCurrentLanguageIndex(void);

   226

NetworkClientInfo *NetworkFindClientInfoFromIndex(uint16 client_index);

   227

NetworkClientState *NetworkFindClientStateFromIndex(uint16 client_index);

   228

unsigned long NetworkResolveHost(const char *hostname);

   229

   230

#endif /* ENABLE_NETWORK */

   231

   232

#endif // NETWORK_DATA_H