Tes::Net::CollatedPacketMessage Struct Reference

Identifies a message packet which contains a collection of other messages, optionally compressed. More...

List of all members.

Public Member Functions
bool	Read (BinaryReader reader)
	Read the message from the given reader .
bool	Write (PacketBuffer packet)
	Write this message to packet .
bool	Write (BinaryWriter writer)
	Write this message to a BinaryWriter.
Public Attributes
ushort	Flags
	See CollatedPacketFlag.
ushort	Reserved
	Reserved for future use.
uint	UncompressedBytes
	Number of uncompressed bytes in the collated packet data.
Properties
static int	UncompressedBytesOffset [get]
	Returns the byte offset to the UncompressedBytes field.
static int	Size [get]
	Returns the byte size of this structure.

---

Detailed Description

Identifies a message packet which contains a collection of other messages, optionally compressed.

A collated packet message contains multiple messages in the standard format: PacketHeader followed by the message data. However, no individual message in the collated packet has its own CRC. Instead, only the

CollatedPacketMessage

has a CRC.

Use T:IO.CollatedPacketDecoder to decode such packets into constituent messages.

---

Member Function Documentation

bool Tes::Net::CollatedPacketMessage::Read

(

BinaryReader

reader

)

[inline]

Read the message from the given reader .

Parameters:

reader

The reader to read from.

Returns:

True

bool Tes::Net::CollatedPacketMessage::Write

(

BinaryWriter

writer

)

[inline]

Write this message to a BinaryWriter.

Parameters:

writer

The binary writer to write to.

Returns:

True

bool Tes::Net::CollatedPacketMessage::Write

(

PacketBuffer

packet

)

[inline]

Write this message to packet .

Parameters:

packet

The packet to write to.

Returns:

True

---

Member Data Documentation

ushort Tes::Net::CollatedPacketMessage::Reserved

Reserved for future use.

Must be zero.

---

Property Documentation

int Tes::Net::CollatedPacketMessage::UncompressedBytesOffset [static, get]

Returns the byte offset to the UncompressedBytes field.

FIXME: use reflection to calculate the offset.

---

The documentation for this struct was generated from the following file:

• CollatedPacketMessage.cs