dtNetGM::DataStreamPacket Class Reference

A DataStreamPacket contains a dtGame::Message blocks to be sent over a Network ot other connected dtGame::GameManager's. More...

#include <datastreampacket.h>

List of all members.

Public Types
typedef GNE::SmartPtr < DataStreamPacket >	sptr
typedef GNE::WeakPtr < DataStreamPacket >	wptr
Public Member Functions
	DataStreamPacket ()
	Constructor.
	DataStreamPacket (GNE::guint16 streamId, GNE::guint16 dataStreamSize, GNE::guint8 packetId=0)
	Constructor.
	DataStreamPacket (const DataStreamPacket &dataStreamPacket)
	Copy constructor, used by the GNE::PacketParser to send a copy of the DataStreamPacket across the Network.
virtual	~DataStreamPacket (void)
	Destructor, public for GNE......
virtual void	writePacket (GNE::Buffer &raw) const
	Writes a DataStreamPacket into a packet stream, used by GNE::PacketParser.
virtual void	readPacket (GNE::Buffer &raw)
	Reads a DataStreamPacket from a packet stream, used by GNE::PacketParser.
virtual int	getSize () const
	Gets the size of the DataStreamPacket, used by GNE::PacketParser.
GNE::gbyte *	GetPayloadBuffer ()
unsigned int	GetPayloadSize ()
void	SetPayloadSize (GNE::guint16 size)
void	SetDataStreamId (GNE::guint16 id)
unsigned int	GetDataStreamId ()
void	SetDataStreamSize (GNE::guint16 size)
unsigned int	GetDataStreamSize ()
void	SetPacketCount (GNE::guint8 count)
unsigned int	GetPacketCount ()
void	SetIndex (GNE::guint8 index)
unsigned int	GetIndex ()
Static Public Attributes
static const int	MAX_PAYLOAD = 500
static const int	ID = GNE::PacketParser::MIN_USER_ID + 1
	ID used by GNE to identify the DataStreamPacket.

---

Detailed Description

A DataStreamPacket contains a dtGame::Message blocks to be sent over a Network ot other connected dtGame::GameManager's.

See also:

dtGame::Message

---

Member Typedef Documentation

typedef GNE::SmartPtr<DataStreamPacket> dtNetGM::DataStreamPacket::sptr

typedef GNE::WeakPtr<DataStreamPacket> dtNetGM::DataStreamPacket::wptr

---

Constructor & Destructor Documentation

dtNetGM::DataStreamPacket::DataStreamPacket

(

)

Constructor.

dtNetGM::DataStreamPacket::DataStreamPacket	(	GNE::guint16	streamId,
		GNE::guint16	dataStreamSize,
		GNE::guint8	packetId = 0
	)

Constructor.

dtNetGM::DataStreamPacket::DataStreamPacket

(

const DataStreamPacket &

dataStreamPacket

)

Copy constructor, used by the GNE::PacketParser to send a copy of the DataStreamPacket across the Network.

Parameters:

messagePacket

the DataStreamPacket to be copied.

dtNetGM::DataStreamPacket::~DataStreamPacket

(

void

)

[virtual]

Destructor, public for GNE......

---

Member Function Documentation

void dtNetGM::DataStreamPacket::writePacket

(

GNE::Buffer &

raw

)

const [virtual]

Writes a DataStreamPacket into a packet stream, used by GNE::PacketParser.

Parameters:

raw

The buffer to write the DataStreamPacket to

void dtNetGM::DataStreamPacket::readPacket

(

GNE::Buffer &

raw

)

[virtual]

Reads a DataStreamPacket from a packet stream, used by GNE::PacketParser.

Parameters:

raw

The buffer to read the DataStreamPacket from

int dtNetGM::DataStreamPacket::getSize

(

)

const [virtual]

Gets the size of the DataStreamPacket, used by GNE::PacketParser.

Returns:

The size

GNE::gbyte* dtNetGM::DataStreamPacket::GetPayloadBuffer

(

)

[inline]

unsigned int dtNetGM::DataStreamPacket::GetPayloadSize

(

)

[inline]

void dtNetGM::DataStreamPacket::SetPayloadSize

(

GNE::guint16

size

)

[inline]

void dtNetGM::DataStreamPacket::SetDataStreamId

(

GNE::guint16

id

)

[inline]

unsigned int dtNetGM::DataStreamPacket::GetDataStreamId

(

)

[inline]

void dtNetGM::DataStreamPacket::SetDataStreamSize

(

GNE::guint16

size

)

[inline]

unsigned int dtNetGM::DataStreamPacket::GetDataStreamSize

(

)

[inline]

void dtNetGM::DataStreamPacket::SetPacketCount

(

GNE::guint8

count

)

[inline]

unsigned int dtNetGM::DataStreamPacket::GetPacketCount

(

)

[inline]

void dtNetGM::DataStreamPacket::SetIndex

(

GNE::guint8

index

)

[inline]

unsigned int dtNetGM::DataStreamPacket::GetIndex

(

)

[inline]

---

Member Data Documentation

const int dtNetGM::DataStreamPacket::MAX_PAYLOAD = 500 [static]

const int dtNetGM::DataStreamPacket::ID = GNE::PacketParser::MIN_USER_ID + 1 [static]

ID used by GNE to identify the DataStreamPacket.

The DataStreamPacket has an ID of GNE::PacketParser::MIN_USER_ID

---