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"

    16

    17

/**

    18

 * Enum with all types of UDP packets.

    19

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

    20

 * it protects old clients from joining newer servers

    21

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

    22

 */

    23

enum {

    24

	PACKET_SERVER_FULL,

    25

	PACKET_SERVER_BANNED,

    26

	PACKET_CLIENT_JOIN,

    27

	PACKET_SERVER_ERROR,

    28

	PACKET_CLIENT_COMPANY_INFO,

    29

	PACKET_SERVER_COMPANY_INFO,

    30

	PACKET_SERVER_CLIENT_INFO,

    31

	PACKET_SERVER_NEED_PASSWORD,

    32

	PACKET_CLIENT_PASSWORD,

    33

	PACKET_SERVER_WELCOME,

    34

	PACKET_CLIENT_GETMAP,

    35

	PACKET_SERVER_WAIT,

    36

	PACKET_SERVER_MAP,

    37

	PACKET_CLIENT_MAP_OK,

    38

	PACKET_SERVER_JOIN,

    39

	PACKET_SERVER_FRAME,

    40

	PACKET_SERVER_SYNC,

    41

	PACKET_CLIENT_ACK,

    42

	PACKET_CLIENT_COMMAND,

    43

	PACKET_SERVER_COMMAND,

    44

	PACKET_CLIENT_CHAT,

    45

	PACKET_SERVER_CHAT,

    46

	PACKET_CLIENT_SET_PASSWORD,

    47

	PACKET_CLIENT_SET_NAME,

    48

	PACKET_CLIENT_QUIT,

    49

	PACKET_CLIENT_ERROR,

    50

	PACKET_SERVER_QUIT,

    51

	PACKET_SERVER_ERROR_QUIT,

    52

	PACKET_SERVER_SHUTDOWN,

    53

	PACKET_SERVER_NEWGAME,

    54

	PACKET_SERVER_RCON,

    55

	PACKET_CLIENT_RCON,

    56

	PACKET_SERVER_CHECK_NEWGRFS,

    57

	PACKET_CLIENT_NEWGRFS_CHECKED,

    58

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

    59

};

    60

    61

/** Packet that wraps a command */

    62

struct CommandPacket {

    63

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

    64

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

    65

	uint32 cmd;        ///< command being executed

    66

	uint32 p1;         ///< parameter p1

    67

	uint32 p2;         ///< parameter p2

    68

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

    69

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

    70

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

    71

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

    72

	bool my_cmd;       ///< did the command originate from "me"

    73

};

    74

    75

/** Status of a client */

    76

enum ClientStatus {

    77

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

    78

	STATUS_AUTHORIZING,///< The client is authorizing

    79

	STATUS_AUTH,       ///< The client is authorized

    80

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

    81

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

    82

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

    83

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

    84

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

    85

};

    86

    87

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

    88

class NetworkTCPSocketHandler : public NetworkSocketHandler {

    89

/* TODO: rewrite into a proper class */

    90

private:

    91

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

    92

	Packet *packet_recv;      ///< Partially received packet

    93

public:

    94

	uint16 index;             ///< Client index

    95

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

    96

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

    97

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

    98

    99

	ClientStatus status;      ///< Status of this client

   100

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

   101

   102

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

   103

   104

	NetworkRecvStatus CloseConnection();

   105

	void Initialize();

   106

	void Destroy();

   107

   108

	void Send_Packet(Packet *packet);

   109

	bool Send_Packets();

   110

	bool IsPacketQueueEmpty();

   111

   112

	Packet *Recv_Packet(NetworkRecvStatus *status);

   113

};

   114

   115

#endif /* ENABLE_NETWORK */

   116

   117

#endif /* NETWORK_CORE_TCP_H */