1

/* $Id$ */

     2

     3

/**

     4

 * @file core.h Base for all network types (UDP and TCP)

     5

 */

     6

     7

#ifndef NETWORK_CORE_H

     8

#define NETWORK_CORE_H

     9

    10

#ifdef ENABLE_NETWORK

    11

    12

#include "os_abstraction.h"

    13

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

    14

    15

bool NetworkCoreInitialize();

    16

void NetworkCoreShutdown();

    17

    18

/** Status of a network client; reasons why a client has quit */

    20

	NETWORK_RECV_STATUS_OKAY,             ///< Everything is okay

    21

	NETWORK_RECV_STATUS_DESYNC,           ///< A desync did occur

    22

	NETWORK_RECV_STATUS_NEWGRF_MISMATCH,  ///< We did not have the required NewGRFs

    23

	NETWORK_RECV_STATUS_SAVEGAME,         ///< Something went wrong (down)loading the savegame

    24

	NETWORK_RECV_STATUS_CONN_LOST,        ///< The conection is 'just' lost

    25

	NETWORK_RECV_STATUS_MALFORMED_PACKET, ///< We apparently send a malformed packet

    26

	NETWORK_RECV_STATUS_SERVER_ERROR,     ///< The server told us we made an error

    27

	NETWORK_RECV_STATUS_SERVER_FULL,      ///< The server is full

    28

	NETWORK_RECV_STATUS_SERVER_BANNED,    ///< The server has banned us

    29

	NETWORK_RECV_STATUS_CLOSE_QUERY,      ///< Done quering the server

    31

    32

/** Forward declaration due to circular dependencies */

    33

struct Packet;

    34

    35

/**

    36

 * SocketHandler for all network sockets in OpenTTD.

    37

 */

    38

class NetworkSocketHandler {

    39

public:

    40

	/* TODO: make socket & has_quit protected once the TCP stuff

    41

	 *is in a real class too */

    42

	bool has_quit; ///< Whether the current client has quit/send a bad packet

    43

	SOCKET sock;   ///< The socket currently connected to

    44

public:

    45

	/** Create a new unbound socket */

    46

	NetworkSocketHandler() { this->sock = INVALID_SOCKET; this->has_quit = false; }

    47

    48

	/** Close the socket when distructing the socket handler */

    49

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

    50

    51

	/** Really close the socket */

    52

	virtual void Close() {}

    53

    54

	/**

    55

	 * Close the current connection; for TCP this will be mostly equivalent

    56

	 * to Close(), but for UDP it just means the packet has to be dropped.

    57

	 * @return new status of the connection.

    58

	 */

    59

	virtual NetworkRecvStatus CloseConnection() { this->has_quit = true; return NETWORK_RECV_STATUS_OKAY; }

    60

    61

	/**

    62

	 * Whether this socket is currently bound to a socket.

    63

	 * @return true when the socket is bound, false otherwise

    64

	 */

    65

	bool IsConnected() { return this->sock != INVALID_SOCKET; }

    66

    67

	/**

    68

	 * Whether the current client connected to the socket has quit.

    69

	 * In the case of UDP, for example, once a client quits (send bad

    70

	 * data), the socket in not closed; only the packet is dropped.

    71

	 * @return true when the current client has quit, false otherwise

    72

	 */

    73

	bool HasClientQuit() { return this->has_quit; }

    74

    75

	void Send_GRFIdentifier(Packet *p, const GRFIdentifier *grf);

    76

	void Recv_GRFIdentifier(Packet *p, GRFIdentifier *grf);

    77

};

    78

    79

#endif /* ENABLE_NETWORK */

    80

    81

#endif /* NETWORK_CORE_H */