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.

    72

 */

    73

    74

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

    75

    76

bool NetworkUDPListen(SOCKET *udp, const uint32 host, const uint16 port, const bool broadcast);

    77

void NetworkUDPClose(SOCKET *udp);

    78

    79

void NetworkSendUDP_Packet(const SOCKET udp, Packet *p, const struct sockaddr_in *recv);

    80

void NetworkUDPReceive(const SOCKET udp);

    81

    82

/**

    83

 * Function that is called for every received UDP packet.

    84

 * @param udp         the socket the packet is received on

    85

 * @param packet      the received packet

    86

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

    87

 */

    88

void NetworkHandleUDPPacket(const SOCKET udp, Packet *p, const struct sockaddr_in *client_addr);

    89

    90

    91

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

    92

    93

    94

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

    95

enum {

    96

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

    97

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

    98

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

    99

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

   100

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

   101

	PACKET_UDP_MASTER_ACK_REGISTER,  ///< Packet indicating registration has succedeed

   102

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

   103

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

   104

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

   105

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

   106

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

   107

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

   108

};

   109

   110

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

   111

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

   112

   113

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

   114

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

   115

   116

/**

   117

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

   118

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

   119

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

   120

 * the grfconfig list of the NetworkGameInfo.

   121

 * @param config the GRF to handle

   122

 */

   123

void HandleIncomingNetworkGameInfoGRFConfig(GRFConfig *config);

   124

   125

#endif /* ENABLE_NETWORK */

   126

   127

#endif /* NETWORK_CORE_UDP_H */