PacketIO Class |
Represents IO to/from one packet, or one section of a packet (eg a header, or a packet encapsulated within another packet).
Inheritance HierarchyNamespace: Demo3D.IO
Assembly: Demo3D.IO (in Demo3D.IO.dll) Version: 15.0.2.11458
SyntaxC#
public abstract class PacketIO : PacketPosition, IOffsetPacketReader, IPacketIO, IDataIO, IDataLocationProvider, IOffsetDataReader, IDataReferenceReader
The PacketIO type exposes the following members.
Constructors
Properties| Name | Description | |
|---|---|---|
 | Endian |
Endianess for integral types.
|
| ID |
Optional ID to identify the packet (eg source/destination, packet section, etc).
|
| IsFixed |
Returns true if this is a fixed size packet. Ensure can't expand a fixed packet.
|
| Length |
Returns the current length of the packet.
The Length of a packet may change without Ensure being called if it's an expandable PacketWriter and data is inserted.
|
| Parent |
Returns the parent packet, or null.
(Inherited from PacketPosition.) |
| Position |
Returns the current position in this packet.
The Position of a packet may change without Advance being called if it's an expandable PacketWriter and data is inserted.
|
| PositionInParent |
Returns the current position with respect to our parent packet.
(Overrides PacketPositionPositionInParent.) |
| Remaining |
Returns the remaining data/space available in this packet. If it's a fixed-size packet, then this is definitive.
Otherwise Ensure can be used to try to extend the packet with more data/space.
|
| TextEncoding |
Encoding for text strings.
|
| Top |
Returns the top parent.
|
Methods| Name | Description | |
|---|---|---|
 | Advance |
Advances the current packet position. Implies Ensure(length).
|
| Ensure |
Ensure that the next length bytes of data/space are available in the packet. If there isn't enough already
available, and the packet isn't fixed, then it'll attempt to read more data into or create more space in the packet.
|
| MarkPosition |
Return a position marker.
|
Extension Methods| Name | Description | |
|---|---|---|
 | ReadBit |
Reads a bit at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadBoolean |
Reads a boolean at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadByte |
Reads from the specified offset and returns the data as a value.
(Defined by DataReferenceExtensions.) |
| ReadBytes(Int32, Int32) | Overloaded.
Reads a number of bytes at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadBytes(Int32, ArraySegmentByte) | Overloaded.
Reads a number of bytes at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadBytes(Int32, IDataWriter, Int32) | Overloaded.
Reads a number of bytes at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadBytes(Int32, Byte, Int32, Int32) | Overloaded.
Reads a number of bytes at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadChar |
Reads a character at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadDouble(Int32) | Overloaded.
Reads a 64bit double floating point number at offset in the buffer.
(Defined by OffsetPacketReaderExtensions.) |
| ReadDouble(Int32, Endian) | Overloaded.
Reads a 64bit double floating point number at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadDoubleBE |
Reads a 64bit double floating point number at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadDoubleLE |
Reads from the specified offset and returns the data as a value.
(Defined by DataReferenceExtensions.) |
| ReadInt16(Int32) | Overloaded.
Reads a 16bit signed integer at offset in the buffer.
(Defined by OffsetPacketReaderExtensions.) |
| ReadInt16(Int32, Endian) | Overloaded.
Reads a 16bit signed integer at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadInt16BE |
Reads a 16bit signed integer at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadInt16LE |
Reads from the specified offset and returns the data as a value.
(Defined by DataReferenceExtensions.) |
| ReadInt32(Int32) | Overloaded.
Reads a 32bit signed integer at offset in the buffer.
(Defined by OffsetPacketReaderExtensions.) |
| ReadInt32(Int32, Endian) | Overloaded.
Reads a 32bit signed integer at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadInt32BE |
Reads a 32bit signed integer at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadInt32LE |
Reads the memory exchange from the specified offset and returns the data as a value.
(Defined by DataReferenceExtensions.) |
| ReadInt64(Int32) | Overloaded.
Reads a 64bit signed integer at offset in the buffer.
(Defined by OffsetPacketReaderExtensions.) |
| ReadInt64(Int32, Endian) | Overloaded.
Reads a 64bit signed integer at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadInt64BE |
Reads a 64bit signed integer at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadInt64LE |
Reads from the specified offset and returns the data as a value.
(Defined by DataReferenceExtensions.) |
| ReadSByte |
Reads from the specified offset and returns the data as a value.
(Defined by DataReferenceExtensions.) |
| ReadSingle(Int32) | Overloaded.
Reads a 32bit single floating point number at offset in the buffer.
(Defined by OffsetPacketReaderExtensions.) |
| ReadSingle(Int32, Endian) | Overloaded.
Reads a 32bit single floating point number at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadSingleBE |
Reads a 32bit single floating point number at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadSingleLE |
Reads from the specified offset and returns the data as a value.
(Defined by DataReferenceExtensions.) |
| ReadString(Int32) | Overloaded.
Reads a string at offset in the buffer.
(Defined by OffsetPacketReaderExtensions.) |
| ReadString(Int32, BinaryTextEncoding) | Overloaded.
Reads a string at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadUInt16 |
Reads a 16bit unsigned integer at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadUInt16BE |
Reads a 16bit unsigned integer at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadUInt16LE |
Reads from the specified offset and returns the data as a value.
(Defined by DataReferenceExtensions.) |
| ReadUInt32(Int32) | Overloaded.
Reads a 32bit unsigned integer at offset in the buffer.
(Defined by OffsetPacketReaderExtensions.) |
| ReadUInt32(Int32, Endian) | Overloaded.
Reads a 32bit unsigned integer at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadUInt32BE |
Reads a 32bit unsigned integer at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadUInt32LE |
Reads from the specified offset and returns the data as a value.
(Defined by DataReferenceExtensions.) |
| ReadUInt64(Int32) | Overloaded.
Reads a 64bit unsigned integer at offset in the buffer.
(Defined by OffsetPacketReaderExtensions.) |
| ReadUInt64(Int32, Endian) | Overloaded.
Reads a 64bit unsigned integer at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadUInt64BE |
Reads a 64bit unsigned integer at offset in the buffer.
(Defined by OffsetDataReaderExtensions.) |
| ReadUInt64LE |
Reads from the specified offset and returns the data as a value.
(Defined by DataReferenceExtensions.) |
See Also