1

/* $Id$ */

     2

     3

/**

     4

 * @file udp.h Basic functions to receive and send UDP packets.

     5

 *

     6

 *

     7

 * *** Requesting game information from a server ***

     8

 *

     9

 * This describes the on-the-wire structure of the request and reply

    10

 * packet of the NetworkGameInfo (see game.h) data.

    11

 *

    12

 * --- Points of attention ---

    13

 *  - all > 1 byte integral values are written in little endian,

    14

 *    unless specified otherwise.

    15

 *      Thus, 0x01234567 would be sent as {0x67, 0x45, 0x23, 0x01}.

    16

 *  - all sent strings are of variable length and terminated by a '\0'.

    17

 *      Thus, the length of the strings is not sent.

    18

 *  - years that are leap years in the 'days since X' to 'date' calculations:

    19

 *     (year % 4 == 0) and ((year % 100 != 0) or (year % 400 == 0))

    20

 *

    21

 * --- Request ---

    22

 * Bytes:  Description:

    23

 *   2       size of the whole packet, in this case 3

    24

 *   1       type of packet, in this case PACKET_UDP_CLIENT_FIND_SERVER (0)

    25

 * This packet would look like: { 0x03, 0x00, 0x00 }

    26

 *

    27

 * --- Reply ---

    28

 * Version: Bytes:  Description:

    29

 *   all      2       size of the whole packet

    30

 *   all      1       type of packet, in this case PACKET_UDP_SERVER_RESPONSE (1)

    31

 *   all      1       the version of this packet's structure

    32

 *

    33

 *   4+       1       number of GRFs attached (n)

    34

 *   4+       n * 20  unique identifier for GRF files. Constists of:

    35

 *                     - one 4 byte variable with the GRF ID

    36

 *                     - 16 bytes (sent sequentially) for the MD5 checksum

    37

 *                       of the GRF

    38

 *

    39

 *   3+       4       current game date in days since 1-1-0 (DMY)

    40

 *   3+       4       game introduction date in days since 1-1-0 (DMY)

    41

 *

    42

 *   2+       1       maximum number of companies allowed on the server

    43

 *   2+       1       number of companies on the server

    44

 *   2+       1       maximum number of spectators allowed on the server

    45

 *

    46

 *   1+       var     string with the name of the server

    47

 *   1+       var     string with the revision of the server

    48

 *   1+       1       the language run on the server

    49

 *                    (0 = any, 1 = English, 2 = German, 3 = French)

    50

 *   1+       1       whether the server uses a password (0 = no, 1 = yes)

    51

 *   1+       1       maximum number of clients allowed on the server

    52

 *   1+       1       number of clients on the server

    53

 *   1+       1       number of spectators on the server

    54

 *   1 & 2    2       current game date in days since 1-1-1920 (DMY)

    55

 *   1 & 2    2       game introduction date in days since 1-1-1920 (DMY)

    56

 *   1+       var     string with the name of the map

    57

 *   1+       2       width of the map in tiles

    58

 *   1+       2       height of the map in tiles

    59

 *   1+       1       type of map:

    60

 *                    (0 = temperate, 1 = arctic, 2 = desert, 3 = toyland)

    61

 *   1+       1       whether the server is dedicated (0 = no, 1 = yes)

    62

 */

    63

    75

/** Enum with all types of UDP packets. The order MUST not be changed **/

    76

enum PacketUDPType {

    77

	PACKET_UDP_CLIENT_FIND_SERVER,   ///< Queries a game server for game information

    78

	PACKET_UDP_SERVER_RESPONSE,      ///< Reply of the game server with game information

    79

	PACKET_UDP_CLIENT_DETAIL_INFO,   ///< Queries a game server about details of the game, such as companies

    80

	PACKET_UDP_SERVER_DETAIL_INFO,   ///< Reply of the game server about details of the game, such as companies

    81

	PACKET_UDP_SERVER_REGISTER,      ///< Packet to register itself to the master server

    82

	PACKET_UDP_MASTER_ACK_REGISTER,  ///< Packet indicating registration has succedeed

    83

	PACKET_UDP_CLIENT_GET_LIST,      ///< Request for serverlist from master server

    84

	PACKET_UDP_MASTER_RESPONSE_LIST, ///< Response from master server with server ip's + port's

    85

	PACKET_UDP_SERVER_UNREGISTER,    ///< Request to be removed from the server-list

    86

	PACKET_UDP_CLIENT_GET_NEWGRFS,   ///< Requests the name for a list of GRFs (GRF_ID and MD5)

    87

	PACKET_UDP_SERVER_NEWGRFS,       ///< Sends the list of NewGRF's requested.

    88

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

    89

};

    90

    91

#define DECLARE_UDP_RECEIVE_COMMAND(type) virtual void NetworkPacketReceive_## type ##_command(Packet *p, const struct sockaddr_in *)

    92

#define DEF_UDP_RECEIVE_COMMAND(cls, type) void cls ##NetworkUDPSocketHandler::NetworkPacketReceive_ ## type ## _command(Packet *p, const struct sockaddr_in *client_addr)

    93

    94

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

    95

class NetworkUDPSocketHandler : public NetworkSocketHandler {

    96

protected:

    97

	NetworkRecvStatus CloseConnection();

    98

    99

	/* Declare all possible packets here. If it can be received by the

   100

	 * a specific handler, it has to be implemented. */

   101

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_FIND_SERVER);

   102

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_RESPONSE);

   103

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_DETAIL_INFO);

   104

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_DETAIL_INFO);

   105

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_REGISTER);

   106

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_ACK_REGISTER);

   107

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_GET_LIST);

   108

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_MASTER_RESPONSE_LIST);

   109

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_UNREGISTER);

   110

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_CLIENT_GET_NEWGRFS);

   111

	DECLARE_UDP_RECEIVE_COMMAND(PACKET_UDP_SERVER_NEWGRFS);

   112

   113

	void HandleUDPPacket(Packet *p, const struct sockaddr_in *client_addr);

   114

   115

	/**

   116

	 * Function that is called for every GRFConfig that is read when receiving

   117

	 * a NetworkGameInfo. Only grfid and md5sum are set, the rest is zero. This

   118

	 * function must set all appropriate fields. This GRF is later appended to

   119

	 * the grfconfig list of the NetworkGameInfo.

   120

	 * @param config the GRF to handle

   121

	 */

   122

	virtual void HandleIncomingNetworkGameInfoGRFConfig(GRFConfig *config) { NOT_REACHED(); }

   123

public:

   124

	/** On destructing of this class, the socket needs to be closed */

   125

	virtual ~NetworkUDPSocketHandler() { this->Close(); }

   126

   127

	bool Listen(uint32 host, uint16 port, bool broadcast);

   128

	void Close();

   129

   130

	void SendPacket(Packet *p, const struct sockaddr_in *recv);

   131

	void ReceivePackets();

   132

   133

	void Send_NetworkGameInfo(Packet *p, const NetworkGameInfo *info);

   134

	void Recv_NetworkGameInfo(Packet *p, NetworkGameInfo *info);

   135

};

   136

   137

#endif /* ENABLE_NETWORK */

   138

   139

#endif /* NETWORK_CORE_UDP_H */