1

/* $Id$ */

     2

     3

#ifndef NETWORK_CORE_H

     4

#define NETWORK_CORE_H

     5

     6

#ifdef ENABLE_NETWORK

     7

     8

#include "os_abstraction.h"

    10

    11

/**

    12

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

    13

 */

    14

    15

bool NetworkCoreInitialize(void);

    16

void NetworkCoreShutdown(void);

    17

    18

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

    19

typedef enum {

    20

	NETWORK_RECV_STATUS_OKAY,             ///< Everything is okay

    21

	NETWORK_RECV_STATUS_DESYNC,           ///< A desync did occur

    22

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

    23

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

    24

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

    25

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

    26

	NETWORK_RECV_STATUS_SERVER_FULL,      ///< The server is full

    27

	NETWORK_RECV_STATUS_SERVER_BANNED,    ///< The server has banned us

    28

	NETWORK_RECV_STATUS_CLOSE_QUERY,      ///< Done quering the server

    29

} NetworkRecvStatus;

    30

    34

/**

    35

 * SocketHandler for all network sockets in OpenTTD.

    36

 */

    37

class NetworkSocketHandler {

    38

public:

    39

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

    40

	 *is in a real class too */

    41

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

    42

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

    43

public:

    44

	/** Create a new unbound socket */

    45

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

    46

    47

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

    48

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

    49

    50

	/** Really close the socket */

    51

	virtual void Close() {}

    52

    53

	/**

    54

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

    55

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

    56

	 * @return new status of the connection.

    57

	 */

    58

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

    59

    60

	/**

    61

	 * Whether this socket is currently bound to a socket.

    62

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

    63

	 */

    64

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

    65

    66

	/**

    67

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

    68

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

    69

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

    70

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

    71

	 */

    72

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

    76

};

    77

    78

#endif /* ENABLE_NETWORK */

    79

    80

#endif /* NETWORK_CORE_H */