1

/* $Id$ */

     2

     3

#ifndef NETWORK_DATA_H

     4

#define NETWORK_DATA_H

     5

     6

// Is the network enabled?

     7

#ifdef ENABLE_NETWORK

     8

     9

#include "../openttd.h"

    10

#include "network.h"

    11

#include "core/os_abstraction.h"

    12

#include "core/core.h"

    13

#include "core/config.h"

    14

#include "core/packet.h"

    15

#include "core/tcp.h"

    16

    17

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

    18

    19

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

    20

#define NETWORK_SERVER_INDEX 1

    21

#define NETWORK_EMPTY_INDEX 0

    22

    23

typedef enum {

    24

	MAP_PACKET_START,

    25

	MAP_PACKET_NORMAL,

    26

	MAP_PACKET_END,

    27

} MapPacket;

    28

    29

typedef enum {

    30

	NETWORK_ERROR_GENERAL, // Try to use thisone like never

    31

    32

	// Signals from clients

    33

	NETWORK_ERROR_DESYNC,

    34

	NETWORK_ERROR_SAVEGAME_FAILED,

    35

	NETWORK_ERROR_CONNECTION_LOST,

    36

	NETWORK_ERROR_ILLEGAL_PACKET,

    37

    38

	// Signals from servers

    39

	NETWORK_ERROR_NOT_AUTHORIZED,

    40

	NETWORK_ERROR_NOT_EXPECTED,

    41

	NETWORK_ERROR_WRONG_REVISION,

    42

	NETWORK_ERROR_NAME_IN_USE,

    43

	NETWORK_ERROR_WRONG_PASSWORD,

    44

	NETWORK_ERROR_PLAYER_MISMATCH, // Happens in CLIENT_COMMAND

    45

	NETWORK_ERROR_KICKED,

    46

	NETWORK_ERROR_CHEATER,

    47

	NETWORK_ERROR_FULL,

    48

} NetworkErrorCode;

    49

    50

// Actions that can be used for NetworkTextMessage

    51

typedef enum {

    52

	NETWORK_ACTION_JOIN,

    53

	NETWORK_ACTION_LEAVE,

    54

	NETWORK_ACTION_SERVER_MESSAGE,

    55

	NETWORK_ACTION_CHAT,

    56

	NETWORK_ACTION_CHAT_COMPANY,

    57

	NETWORK_ACTION_CHAT_CLIENT,

    58

	NETWORK_ACTION_GIVE_MONEY,

    59

	NETWORK_ACTION_NAME_CHANGE,

    60

} NetworkAction;

    61

    62

typedef enum {

    63

	NETWORK_GAME_PASSWORD,

    64

	NETWORK_COMPANY_PASSWORD,

    65

} NetworkPasswordType;

    66

    67

typedef enum {

    68

	DESTTYPE_BROADCAST, ///< Send message/notice to all players (All)

    69

	DESTTYPE_TEAM,    ///< Send message/notice to everyone playing the same company (Team)

    70

	DESTTYPE_CLIENT,    ///< Send message/notice to only a certain player (Private)

    71

} DestType;

    72

    73

// following externs are instantiated at network.cpp

    74

extern CommandPacket *_local_command_queue;

    75

    76

// Here we keep track of the clients

    77

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

    78

extern NetworkTCPSocketHandler _clients[MAX_CLIENTS];

    79

    80

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

    81

// This returns the NetworkClientInfo from a NetworkClientState

    82

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

    83

    84

// Macros to make life a bit more easier

    85

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

    86

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

    87

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

    88

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

    89

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

    90

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

    91

    92

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

    93

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

    94

    95

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

    96

#define FOR_ALL_ACTIVE_CLIENT_INFOS(ci) for (ci = _network_client_info; ci != endof(_network_client_info); ci++) if (ci->client_index != NETWORK_EMPTY_INDEX)

    97

    98

void NetworkExecuteCommand(CommandPacket *cp);

    99

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

   100

   101

// from network.c

   102

void NetworkCloseClient(NetworkTCPSocketHandler *cs);

   103

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

   104

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

   105

uint NetworkCalculateLag(const NetworkTCPSocketHandler *cs);

   106

byte NetworkGetCurrentLanguageIndex(void);

   107

NetworkClientInfo *NetworkFindClientInfoFromIndex(uint16 client_index);

   108

NetworkClientInfo *NetworkFindClientInfoFromIP(const char *ip);

   109

NetworkTCPSocketHandler *NetworkFindClientStateFromIndex(uint16 client_index);

   110

unsigned long NetworkResolveHost(const char *hostname);

   111

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

   112

   113

#endif /* ENABLE_NETWORK */

   114

   115

#endif /* NETWORK_DATA_H */