Tes::IO Namespace Reference

Classes
class	CollatedPacketDecoder
	A utility class for decoding CollatedPacketMessage packets. More...
class	CollatedPacketEncoder
	A utility class for encoding CollatedPacketMessage packets, including compression. More...
class	CollationStream
	A stream implementation which uses a T:IO.CollatedPacketEncoder to compress data before writing to another stream. More...
class	Crc16
	This class is used to calculate a 2-byte/16-bit CRC value for a memory buffer. More...
class	Endian
	Endian swap operations.
class	GZipUtil
	GZip utility methods.
class	NetworkReader
	A BinaryReader implementation designed to read data from network Endian (big) to the local host Endian. More...
class	NetworkWriter
	A BinaryWriter designed to write to network Endian (big). More...
class	InvalidPacketStatusException
	Exception thrown when a PacketBuffer is in an invalid state for the current operation. More...
class	PacketBuffer
	The Tes.IO.PacketBuffer is used to collate incoming network data and extract a Tes.IO.PacketHeader and payload. More...
struct	PacketHeader
	The header for an incoming 3ES data packet. More...
class	PacketStreamReader
	The StreamReader supports reading and decoding of a data stream into T:PacketBuffer packets. More...
class	ReusableMemoryStream
	Implements a MemoryStream wrapper to support GZip compression. More...
Enumerations
enum	PacketBufferStatus {   Empty, Collating, Available, Complete,   Error, CrcError }
	Status values for a PacketBuffer More...
enum	PacketFlag { NoCrc = (1 << 0) }
	Flag values for PacketHeader. More...

---

Enumeration Type Documentation

enum Tes::IO::PacketBufferStatus

Status values for a PacketBuffer

Enumerator:

Empty	No data.
Collating	Data present in the packet, but not enough for a full message.
Available	The packet contains data for at least one full message. Call PacketBuffer.PopPacket(out bool) until the status is no longer Available .
Complete	Packet contains a single, complete message. Only set when for packets when writing is finalised PacketBuffer.FinalisePacket(bool) or for a packet extracted using PacketBuffer.PopPacket(out bool).
Error	Packet error has occurred.
CrcError	Calculated CRC does not match the read value.

enum Tes::IO::PacketFlag

Flag values for PacketHeader.

Enumerator:

NoCrc

Marks the packet has missing its 16-bit CRC.