1

/* $Id$ */

     2

     3

#ifndef NETWORK_CORE_UDP_H

     4

#define NETWORK_CORE_UDP_H

     5

     6

#ifdef ENABLE_NETWORK

     7

     8

#include "os_abstraction.h"

     9

#include "game.h"

    10

#include "packet.h"

    11

#include "../../newgrf_config.h"

    12

    13

/**

    14

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

    15

 */

    16

    17

///** Sending/receiving of UDP packets **////

    18

    20

void NetworkUDPClose(SOCKET *udp);

    21

    24

    25

/**

    26

 * Function that is called for every received UDP packet.

    27

 * @param udp         the socket the packet is received on

    28

 * @param packet      the received packet

    29

 * @param client_addr the address of the sender of the packet

    30

 */

    32

    33

    34

///** Sending/receiving of (large) chuncks of UDP packets **////

    35

    36

    37

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

    38

enum {

    39

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

    40

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

    41

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

    42

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

    43

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

    44

	PACKET_UDP_MASTER_ACK_REGISTER,  ///< Packet indicating registration has succedeed

    45

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

    46

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

    47

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

    48

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

    49

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

    50

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

    51

};

    52

    53

void NetworkSend_GRFIdentifier(Packet *p, const GRFConfig *c);

    54

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

    55

    56

void NetworkRecv_GRFIdentifier(NetworkClientState *cs, Packet *p, GRFConfig *c);

    57

void NetworkRecv_NetworkGameInfo(NetworkClientState *cs, Packet *p, NetworkGameInfo *info);

    58

    59

/**

    60

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

    61

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

    62

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

    63

 * the grfconfig list of the NetworkGameInfo.

    64

 * @param config the GRF to handle

    65

 */

    66

void HandleIncomingNetworkGameInfoGRFConfig(GRFConfig *config);

    67

    68

#endif /* ENABLE_NETWORK */

    69

    70

#endif /* NETWORK_CORE_UDP_H */