rubidium@5469: /* $Id$ */
rubidium@5469: 
rubidium@5469: #ifndef NETWORK_CORE_PACKET_H
rubidium@5469: #define NETWORK_CORE_PACKET_H
rubidium@5469: 
rubidium@5469: #ifdef ENABLE_NETWORK
rubidium@5469: 
rubidium@5469: /**
rubidium@5469:  * @file packet.h Basic functions to create, fill and read packets.
rubidium@5469:  */
rubidium@5469: 
rubidium@5469: typedef struct NetworkClientState NetworkClientState;
rubidium@5469: 
rubidium@5469: /**
rubidium@5469:  * Queries the network client state struct to determine whether
rubidium@5469:  * the client has quit. It indirectly also queries whether the
rubidium@5469:  * packet is corrupt as the connection will be closed if it is
rubidium@5469:  * reading beyond the boundary of the received packet.
rubidium@5469:  * @param cs the state to query
rubidium@5469:  * @param true if the connection should be considered dropped
rubidium@5469:  */
rubidium@5469: bool HasClientQuit(NetworkClientState *cs);
rubidium@5469: 
rubidium@5469: typedef uint16 PacketSize; ///< Size of the whole packet.
rubidium@5469: typedef uint8  PacketType; ///< Identifier for the packet
rubidium@5469: 
rubidium@5469: /**
rubidium@5469:  * Internal entity of a packet. As everything is sent as a packet,
rubidium@5469:  * all network communication will need to call the functions that
rubidium@5469:  * populate the packet.
rubidium@5469:  * Every packet can be at most SEND_MTU bytes. Overflowing this
rubidium@5469:  * limit will give an assertion when sending (i.e. writing) the
rubidium@5469:  * packet. Reading past the size of the packet when receiving
rubidium@5469:  * will return all 0 values and "" in case of the string.
rubidium@5469:  */
rubidium@5469: typedef struct Packet {
rubidium@5469: 	/** The next packet. Used for queueing packets before sending. */
rubidium@5469: 	struct Packet *next;
rubidium@5469: 	/** The size of the whole packet for received packets. For packets
rubidium@5469: 	 * that will be sent, the value is filled in just before the
rubidium@5469: 	 * actual transmission. */
rubidium@5469: 	PacketSize size;
rubidium@5469: 	/** The current read/write position in the packet */
rubidium@5469: 	PacketSize pos;
rubidium@5469: 	/** The buffer of this packet */
rubidium@5469: 	byte buffer[SEND_MTU];
rubidium@5469: } Packet;
rubidium@5469: 
rubidium@5469: 
rubidium@5469: Packet *NetworkSend_Init(PacketType type);
rubidium@5469: void NetworkSend_FillPacketSize(Packet *packet);
rubidium@5469: void NetworkSend_uint8 (Packet *packet, uint8 data);
rubidium@5469: void NetworkSend_uint16(Packet *packet, uint16 data);
rubidium@5469: void NetworkSend_uint32(Packet *packet, uint32 data);
rubidium@5469: void NetworkSend_uint64(Packet *packet, uint64 data);
rubidium@5469: void NetworkSend_string(Packet *packet, const char* data);
rubidium@5469: 
rubidium@5469: void NetworkRecv_ReadPacketSize(Packet *packet);
rubidium@5469: uint8  NetworkRecv_uint8 (NetworkClientState *cs, Packet *packet);
rubidium@5469: uint16 NetworkRecv_uint16(NetworkClientState *cs, Packet *packet);
rubidium@5469: uint32 NetworkRecv_uint32(NetworkClientState *cs, Packet *packet);
rubidium@5469: uint64 NetworkRecv_uint64(NetworkClientState *cs, Packet *packet);
rubidium@5469: void   NetworkRecv_string(NetworkClientState *cs, Packet *packet, char* buffer, size_t size);
rubidium@5469: 
rubidium@5469: #endif /* ENABLE_NETWORK */
rubidium@5469: 
rubidium@5469: #endif /* NETWORK_CORE_PACKET_H */