1

/* $Id$ */

     2

     3

/**

     4

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

     5

 */

     6

     7

#ifndef NETWORK_CORE_TCP_H

     8

#define NETWORK_CORE_TCP_H

     9

    10

#ifdef ENABLE_NETWORK

    11

    12

#include "os_abstraction.h"

    13

#include "core.h"

    14

#include "packet.h"

    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_SERVER_CHECK_NEWGRFS,

    56

	PACKET_CLIENT_NEWGRFS_CHECKED,

    57

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

    58

};

    59

    60

/** Packet that wraps a command */

    61

typedef struct CommandPacket {

    62

	struct CommandPacket *next; ///< the next command packet (if in queue)

    63

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

    64

	uint32 cmd;        ///< command being executed

    65

	uint32 p1;         ///< parameter p1

    66

	uint32 p2;         ///< parameter p2

    67

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

    68

	char text[80];     ///< possible text sent for name changes etc

    69

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

    70

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

    71

} CommandPacket;

    72

    73

/** Status of a client */

    74

typedef enum {

    75

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

    77

	STATUS_AUTH,       ///< The client is authorized

    78

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

    79

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

    80

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

    81

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

    82

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

    83

} ClientStatus;

    84

    85

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

    86

class NetworkTCPSocketHandler : public NetworkSocketHandler {

    87

/* TODO: rewrite into a proper class */

    88

private:

    89

	Packet *packet_queue;     ///< Packets that are awaiting delivery

    90

	Packet *packet_recv;      ///< Partially received packet

    91

public:

    92

	uint16 index;             ///< Client index

    93

	uint32 last_frame;        ///< Last frame we have executed

    94

	uint32 last_frame_server; ///< Last frame the server has executed

    95

	byte lag_test;            ///< Byte used for lag-testing the client

    96

    97

	ClientStatus status;      ///< Status of this client

    98

	bool writable;            ///< Can we write to this socket?

    99

   100

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

   101

   102

	NetworkRecvStatus CloseConnection();

   103

	void Initialize();

   104

	void Destroy();

   105

   106

	void Send_Packet(Packet *packet);

   107

	bool Send_Packets();

   108

	bool IsPacketQueueEmpty();

   109

   110

	Packet *Recv_Packet(NetworkRecvStatus *status);

   111

};

   112

   113

#endif /* ENABLE_NETWORK */

   114

   115

#endif /* NETWORK_CORE_TCP_H */