1

/* $Id$ */

     2

     3

/**

     4

 * @file packet.h Basic functions to create, fill and read packets.

     5

 */

     6

     7

#ifndef NETWORK_CORE_PACKET_H

     8

#define NETWORK_CORE_PACKET_H

     9

    10

#ifdef ENABLE_NETWORK

    11

    12

#include "config.h"

    13

#include "core.h"

    14

    15

typedef uint16 PacketSize; ///< Size of the whole packet.

    16

typedef uint8  PacketType; ///< Identifier for the packet

    17

    18

/**

    19

 * Internal entity of a packet. As everything is sent as a packet,

    20

 * all network communication will need to call the functions that

    21

 * populate the packet.

    22

 * Every packet can be at most SEND_MTU bytes. Overflowing this

    23

 * limit will give an assertion when sending (i.e. writing) the

    24

 * packet. Reading past the size of the packet when receiving

    25

 * will return all 0 values and "" in case of the string.

    26

 */

    27

struct Packet {

    28

	/** The next packet. Used for queueing packets before sending. */

    29

	Packet *next;

    30

	/** The size of the whole packet for received packets. For packets

    31

	 * that will be sent, the value is filled in just before the

    32

	 * actual transmission. */

    33

	PacketSize size;

    34

	/** The current read/write position in the packet */

    35

	PacketSize pos;

    36

	/** The buffer of this packet */

    37

	byte buffer[SEND_MTU];

    38

private:

    39

	NetworkSocketHandler *cs;

    40

    41

public:

    42

	Packet(NetworkSocketHandler *cs);

    43

	Packet(PacketType type);

    44

    45

	/* Sending/writing of packets */

    47

    48

	void Send_bool  (bool   data);

    49

	void Send_uint8 (uint8  data);

    50

	void Send_uint16(uint16 data);

    51

	void Send_uint32(uint32 data);

    52

	void Send_uint64(uint64 data);

    53

	void Send_string(const char* data);

    54

    55

	/* Reading/receiving of packets */

    58

    59

	bool   CanReadFromPacket (uint bytes_to_read);

    65

	void   Recv_string(char* buffer, size_t size);

    66

};

    67

    68

Packet *NetworkSend_Init(PacketType type);

    69

    70

#endif /* ENABLE_NETWORK */

    71

    72

#endif /* NETWORK_CORE_PACKET_H */