LengthEncodedFormat Class

Defines a TelegramFormat that can be length-encoded.

Inheritance Hierarchy

SystemObject
Demo3D.HLE.Comms.TelegramTelegramFormat
Demo3D.HLE.Comms.TelegramLengthEncodedFormat

Namespace: Demo3D.HLE.Comms.Telegram
Assembly: Demo3D.HLE (in Demo3D.HLE.dll) Version: 18.03.00

Syntax

[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public sealed class LengthEncodedFormat : TelegramFormat, 
	ILengthEncoded

The LengthEncodedFormat type exposes the following members.

Constructors

	Name	Description
	LengthEncodedFormat	Constructs a DelimitedFormat.

Properties

	Name	Description
	IgnoreLengthEncoding	Set to ignore format length encoding.
	IsBuilt	True if the format has been built into a data type. (Inherited from TelegramFormat.)
	Length	Format byte length. (Overrides TelegramFormatLength.)
	LengthEncoding	Format length encoding type.
	Name	Format name. (Inherited from TelegramFormat.)

Methods

	Name	Description
	AddSegment	Adds and appends a new TelegramFormatSegment. (Overrides TelegramFormatAddSegment(TelegramFormatSegment).)
	Build	Builds the format into a usable data type. (Overrides TelegramFormatBuild.)
	CreateInstance	Creates an instance of the format data type, i.e., a formatted telegram. (Inherited from TelegramFormat.)
	FindSegment	Returns an identified TelegramFormatSegment, or null. (Inherited from TelegramFormat.)
	GetDataType	Gets the built data type representing the format. (Inherited from TelegramFormat.)
	InsertSegment	Inserts a new TelegramFormatSegment at the specified index. (Overrides TelegramFormatInsertSegment(TelegramFormatSegment, Int32).)
	ProcessInboundTelegram	Processes an inbound telegram. (Overrides TelegramFormatProcessInboundTelegram(BufferSegment).)
	ProcessInboundTelegramToSegments	Processes an inbound telegram into its segments. (Overrides TelegramFormatProcessInboundTelegramToSegments(BufferSegment).)
	ProcessOutboundTelegram	Processes an outbound telegram. (Overrides TelegramFormatProcessOutboundTelegram(BufferSegment).)
	ProcessSegmentsToOutboundTelegram	Processes telegram segments into an outbound telegram. (Overrides TelegramFormatProcessSegmentsToOutboundTelegram(IListBufferSegment).)
	RemoveSegment	Removes a TelegramFormatSegment by name. (Inherited from TelegramFormat.)
	ReplaceSegments	Replace all current segments with the provided. (Overrides TelegramFormatReplaceSegments(IEnumerableTelegramFormatSegment).)
	ToString	(Inherited from TelegramFormat.)

Events

	Name	Description
	PropertyChanged	Raised when a property changes. (Inherited from TelegramFormat.)
	SegmentPropertyChanged	Raised when the properties of a segment is changed. (Inherited from TelegramFormat.)
	SegmentsChanged	Raised when Segments has changed. (Inherited from TelegramFormat.)

Extension Methods

	Name	Description
	Decode	Decodes length-encoded data. Returns encoded data bytes and encoding size. (Defined by ILengthEncodedExtensions.)
	Encode	Encodes data length. Length bytes are directly before data bytes. (Defined by ILengthEncodedExtensions.)
	GetLengthEncodingSize	Returns the length encoding byte size. (Defined by ILengthEncodedExtensions.)

Remarks

Segment byte length is always dynamic (-1).

Length-encoded by default, set IgnoreLengthEncoding to disable.