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

    24

	MAP_PACKET_START,

    25

	MAP_PACKET_NORMAL,

    26

	MAP_PACKET_END,

    28

    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

	NETWORK_ERROR_NEWGRF_MISMATCH,

    38

    39

	// Signals from servers

    40

	NETWORK_ERROR_NOT_AUTHORIZED,

    41

	NETWORK_ERROR_NOT_EXPECTED,

    42

	NETWORK_ERROR_WRONG_REVISION,

    43

	NETWORK_ERROR_NAME_IN_USE,

    44

	NETWORK_ERROR_WRONG_PASSWORD,

    45

	NETWORK_ERROR_PLAYER_MISMATCH, // Happens in CLIENT_COMMAND

    46

	NETWORK_ERROR_KICKED,

    47

	NETWORK_ERROR_CHEATER,

    48

	NETWORK_ERROR_FULL,

    50

    51

// Actions that can be used for NetworkTextMessage

    53

	NETWORK_ACTION_JOIN,

    54

	NETWORK_ACTION_LEAVE,

    55

	NETWORK_ACTION_SERVER_MESSAGE,

    56

	NETWORK_ACTION_CHAT,

    57

	NETWORK_ACTION_CHAT_COMPANY,

    58

	NETWORK_ACTION_CHAT_CLIENT,

    59

	NETWORK_ACTION_GIVE_MONEY,

    60

	NETWORK_ACTION_NAME_CHANGE,

    62

    64

	NETWORK_GAME_PASSWORD,

    65

	NETWORK_COMPANY_PASSWORD,

    67

    69

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

    70

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

    71

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

    73

    74

// following externs are instantiated at network.cpp

    75

extern CommandPacket *_local_command_queue;

    76

    77

// Here we keep track of the clients

    78

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

    79

extern NetworkTCPSocketHandler _clients[MAX_CLIENTS];

    80

    81

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

    82

// This returns the NetworkClientInfo from a NetworkClientState

    83

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

    84

    85

// Macros to make life a bit more easier

    86

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

    88

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

    89

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

    90

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

    91

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

    92

    93

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

    94

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

    95

    96

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

    97

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

    98

    99

void NetworkExecuteCommand(CommandPacket *cp);

   100

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

   101

   102

// from network.c

   103

void NetworkCloseClient(NetworkTCPSocketHandler *cs);

   104

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

   105

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

   106

uint NetworkCalculateLag(const NetworkTCPSocketHandler *cs);

   108

NetworkClientInfo *NetworkFindClientInfoFromIndex(uint16 client_index);

   109

NetworkClientInfo *NetworkFindClientInfoFromIP(const char *ip);

   110

NetworkTCPSocketHandler *NetworkFindClientStateFromIndex(uint16 client_index);

   111

unsigned long NetworkResolveHost(const char *hostname);

   112

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

   113

   114

#endif /* ENABLE_NETWORK */

   115

   116

#endif /* NETWORK_DATA_H */