1

/* $Id$ */

     2

     3

#ifndef NETWORK_CORE_TCP_H

     4

#define NETWORK_CORE_TCP_H

     5

     6

#ifdef ENABLE_NETWORK

     7

     8

#include "os_abstraction.h"

     9

#include "core.h"

    10

#include "packet.h"

    11

    12

/**

    13

 * @file tcp.h Basic functions to receive and send TCP packets.

    14

 */

    15

    16

/**

    17

 * Enum with all types of UDP packets.

    18

 * The order of the first 4 packets MUST not be changed, as

    19

 * it protects old clients from joining newer servers

    20

 * (because SERVER_ERROR is the respond to a wrong revision)

    21

 */

    22

enum {

    23

	PACKET_SERVER_FULL,

    24

	PACKET_SERVER_BANNED,

    25

	PACKET_CLIENT_JOIN,

    26

	PACKET_SERVER_ERROR,

    27

	PACKET_CLIENT_COMPANY_INFO,

    28

	PACKET_SERVER_COMPANY_INFO,

    29

	PACKET_SERVER_CLIENT_INFO,

    30

	PACKET_SERVER_NEED_PASSWORD,

    31

	PACKET_CLIENT_PASSWORD,

    32

	PACKET_SERVER_WELCOME,

    33

	PACKET_CLIENT_GETMAP,

    34

	PACKET_SERVER_WAIT,

    35

	PACKET_SERVER_MAP,

    36

	PACKET_CLIENT_MAP_OK,

    37

	PACKET_SERVER_JOIN,

    38

	PACKET_SERVER_FRAME,

    39

	PACKET_SERVER_SYNC,

    40

	PACKET_CLIENT_ACK,

    41

	PACKET_CLIENT_COMMAND,

    42

	PACKET_SERVER_COMMAND,

    43

	PACKET_CLIENT_CHAT,

    44

	PACKET_SERVER_CHAT,

    45

	PACKET_CLIENT_SET_PASSWORD,

    46

	PACKET_CLIENT_SET_NAME,

    47

	PACKET_CLIENT_QUIT,

    48

	PACKET_CLIENT_ERROR,

    49

	PACKET_SERVER_QUIT,

    50

	PACKET_SERVER_ERROR_QUIT,

    51

	PACKET_SERVER_SHUTDOWN,

    52

	PACKET_SERVER_NEWGAME,

    53

	PACKET_SERVER_RCON,

    54

	PACKET_CLIENT_RCON,

    55

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

    56

};

    57

    59

typedef struct CommandPacket {

    61

	PlayerByte player; ///< player that is executing the command

    62

	uint32 cmd;        ///< command being executed

    63

	uint32 p1;         ///< parameter p1

    64

	uint32 p2;         ///< parameter p2

    65

	TileIndex tile;    ///< tile command being executed on

    67

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

    68

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

    69

} CommandPacket;

    70

    72

typedef enum {

    73

	STATUS_INACTIVE,   ///< The client is not connected nor active

    74

	STATUS_AUTH,       ///< The client is authorized

    75

	STATUS_MAP_WAIT,   ///< The client is waiting as someone else is downloading the map

    76

	STATUS_MAP,        ///< The client is downloading the map

    77

	STATUS_DONE_MAP,   ///< The client has downloaded the map

    78

	STATUS_PRE_ACTIVE, ///< The client is catching up the delayed frames

    79

	STATUS_ACTIVE,     ///< The client is an active player in the game

    80

} ClientStatus;

    81

    82

/** Base socket handler for all TCP sockets */

    83

class NetworkTCPSocketHandler : public NetworkSocketHandler {

    84

/* TODO: rewrite into a proper class */

    85

public:

    90

    93

    96

    98

    99

	NetworkRecvStatus CloseConnection();

   100

	void Initialize();

   101

};

   102

   103

   104

   105

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

   106

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

   107

bool NetworkSend_Packets(NetworkTCPSocketHandler *cs);

   108

   109

#endif /* ENABLE_NETWORK */

   110

   111

#endif /* NETWORK_CORE_TCP_H */