1

/* $Id$ */

     2

     3

#ifndef NETWORK_DATA_H

     4

#define NETWORK_DATA_H

     5

     6

#include "../openttd.h"

     7

#include "network.h"

     8

#include "network_internal.h"

     9

    10

// Is the network enabled?

    11

#ifdef ENABLE_NETWORK

    12

    13

#include "core/os_abstraction.h"

    14

#include "core/core.h"

    15

#include "core/config.h"

    16

#include "core/packet.h"

    17

#include "core/tcp.h"

    18

    19

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

    20

    21

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

    22

#define NETWORK_SERVER_INDEX 1

    23

#define NETWORK_EMPTY_INDEX 0

    24

    25

enum MapPacket {

    26

	MAP_PACKET_START,

    27

	MAP_PACKET_NORMAL,

    28

	MAP_PACKET_END,

    29

};

    30

    31

enum NetworkErrorCode {

    32

	NETWORK_ERROR_GENERAL, // Try to use thisone like never

    33

    34

	// Signals from clients

    35

	NETWORK_ERROR_DESYNC,

    36

	NETWORK_ERROR_SAVEGAME_FAILED,

    37

	NETWORK_ERROR_CONNECTION_LOST,

    38

	NETWORK_ERROR_ILLEGAL_PACKET,

    39

	NETWORK_ERROR_NEWGRF_MISMATCH,

    40

    41

	// Signals from servers

    42

	NETWORK_ERROR_NOT_AUTHORIZED,

    43

	NETWORK_ERROR_NOT_EXPECTED,

    44

	NETWORK_ERROR_WRONG_REVISION,

    45

	NETWORK_ERROR_NAME_IN_USE,

    46

	NETWORK_ERROR_WRONG_PASSWORD,

    47

	NETWORK_ERROR_PLAYER_MISMATCH, // Happens in CLIENT_COMMAND

    48

	NETWORK_ERROR_KICKED,

    49

	NETWORK_ERROR_CHEATER,

    50

	NETWORK_ERROR_FULL,

    51

};

    52

    53

// Actions that can be used for NetworkTextMessage

    54

enum NetworkAction {

    55

	NETWORK_ACTION_JOIN,

    56

	NETWORK_ACTION_LEAVE,

    57

	NETWORK_ACTION_SERVER_MESSAGE,

    58

	NETWORK_ACTION_CHAT,

    59

	NETWORK_ACTION_CHAT_COMPANY,

    60

	NETWORK_ACTION_CHAT_CLIENT,

    61

	NETWORK_ACTION_GIVE_MONEY,

    62

	NETWORK_ACTION_NAME_CHANGE,

    63

};

    64

    65

enum NetworkPasswordType {

    66

	NETWORK_GAME_PASSWORD,

    67

	NETWORK_COMPANY_PASSWORD,

    68

};

    69

    70

enum DestType {

    71

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

    72

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

    73

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

    74

};

    75

    76

// following externs are instantiated at network.cpp

    77

extern CommandPacket *_local_command_queue;

    78

    79

// Here we keep track of the clients

    80

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

    81

extern NetworkTCPSocketHandler _clients[MAX_CLIENTS];

    82

    83

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

    84

// This returns the NetworkClientInfo from a NetworkClientState

    85

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

    86

    87

// Macros to make life a bit more easier

    88

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

    89

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

    90

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

    91

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

    92

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

    93

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

    94

    95

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

    96

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

    97

    98

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

    99

#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)

   100

   101

void NetworkExecuteCommand(CommandPacket *cp);

   102

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

   103

   104

// from network.c

   105

void NetworkCloseClient(NetworkTCPSocketHandler *cs);

   106

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

   107

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

   108

uint NetworkCalculateLag(const NetworkTCPSocketHandler *cs);

   109

byte NetworkGetCurrentLanguageIndex();

   110

NetworkClientInfo *NetworkFindClientInfoFromIndex(uint16 client_index);

   111

NetworkClientInfo *NetworkFindClientInfoFromIP(const char *ip);

   112

NetworkTCPSocketHandler *NetworkFindClientStateFromIndex(uint16 client_index);

   113

unsigned long NetworkResolveHost(const char *hostname);

   114

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

   115

   116

#endif /* ENABLE_NETWORK */

   117

   118

#endif /* NETWORK_DATA_H */