Class BaseMessage<THeader>

Base class for messages.

Inheritance

System.Object

ResizableMessage

BaseMessage<THeader>

Implements

IMessage

IFieldSet

ICloneable

Inherited Members

ResizableMessage.buffer

ResizableMessage.Buffer

ResizableMessage.Wrap(MemoryPointer<Byte>, Boolean)

ResizableMessage.Wrap(MemoryPointer<Byte>, Boolean, Boolean)

ResizableMessage.Resize(Span<Byte>, Int32, Int32)

Namespace: OnixS.SimpleBinaryEncoding

Assembly: OnixS.SimpleBinaryEncoding.dll

Syntax

public abstract class BaseMessage<THeader> : ResizableMessage, IMessage, IFieldSet, ICloneable where THeader : struct, IHeader

Type Parameters

Name	Description
THeader

Properties

BlockLength

Length of the fixed size of the message.

Declaration

public ushort BlockLength { get; }

Property Value

Type	Description
System.UInt16

Item[Int32]

Declaration

public string this[int tag] { get; set; }

Parameters

Type	Name	Description
System.Int32	tag

Property Value

Type	Description
System.String

MsgSize

Length of the entire message, including the binary header, in the number of bytes.

Declaration

public override ushort MsgSize { get; }

Property Value

Type	Description
System.UInt16

Overrides

ResizableMessage.MsgSize

SchemaID

Id of the system publishing the message.

Declaration

public ushort SchemaID { get; }

Property Value

Type	Description
System.UInt16

SchemaIdUsedForDecode

Declaration

public abstract ushort SchemaIdUsedForDecode { get; }

Property Value

Type	Description
System.UInt16

SchemaVersionUsedForDecode

Declaration

public abstract ushort SchemaVersionUsedForDecode { get; }

Property Value

Type	Description
System.UInt16

SemanticType

Declaration

public abstract string SemanticType { get; }

Property Value

Type	Description
System.String

TemplateID

Template ID used to encode the message.

Declaration

public ushort TemplateID { get; }

Property Value

Type	Description
System.UInt16

Version

Schema version.

Declaration

public ushort Version { get; }

Property Value

Type	Description
System.UInt16

Methods

Clone()

Creates a new object that is a copy of the current instance.

Declaration

public abstract IMessage Clone()

Returns

Type	Description
IMessage	A new object that is a copy of this instance.

Contains(Int32)

Declaration

public abstract bool Contains(int tag)

Parameters

Type	Name	Description
System.Int32	tag

Returns

Type	Description
System.Boolean

Duplicate()

Duplicates instance of the message without data. It is assumed that the Wrap method will then be called for the duplicate.

Declaration

public BaseMessage<THeader> Duplicate()

Returns

Type	Description
BaseMessage<THeader>

GetBoolean(Int32)

Declaration

public abstract bool GetBoolean(int tag)

Parameters

Type	Name	Description
System.Int32	tag

Returns

Type	Description
System.Boolean

GetByte(Int32)

Declaration

public abstract byte GetByte(int tag)

Parameters

Type	Name	Description
System.Int32	tag

Returns

Type	Description
System.Byte

GetBytes(Int32)

Declaration

public abstract ReadOnlySpan<byte> GetBytes(int tag)

Parameters

Type	Name	Description
System.Int32	tag

Returns

Type	Description
ReadOnlySpan<System.Byte>

GetChar(Int32)

Declaration

public abstract char GetChar(int tag)

Parameters

Type	Name	Description
System.Int32	tag

Returns

Type	Description
System.Char

GetComposite(Int32)

Declaration

public abstract IComposite GetComposite(int tag)

Parameters

Type	Name	Description
System.Int32	tag

Returns

Type	Description
IComposite

GetComposite<T>(Int32)

Declaration

public abstract T GetComposite<T>(int tag)

    where T : IComposite

Parameters

Type	Name	Description
System.Int32	tag

Returns

Type	Description
T

Type Parameters

Name	Description
T

GetDecimal(Int32)

Declaration

public abstract decimal GetDecimal(int tag)

Parameters

Type	Name	Description
System.Int32	tag

Returns

Type	Description
System.Decimal

GetEnum<T>(Int32)

Declaration

public abstract T GetEnum<T>(int tag)

    where T : struct

Parameters

Type	Name	Description
System.Int32	tag

Returns

Type	Description
T

Type Parameters

Name	Description
T

GetGroup(Int32)

Declaration

public abstract IGroup GetGroup(int tag)

Parameters

Type	Name	Description
System.Int32	tag

Returns

Type	Description
IGroup

GetInteger(Int32)

Declaration

public abstract int GetInteger(int tag)

Parameters

Type	Name	Description
System.Int32	tag

Returns

Type	Description
System.Int32

GetLong(Int32)

Declaration

public abstract long GetLong(int tag)

Parameters

Type	Name	Description
System.Int32	tag

Returns

Type	Description
System.Int64

GetMaturityMonthYear(Int32)

Declaration

public abstract IMaturityMonthYear GetMaturityMonthYear(int tag)

Parameters

Type	Name	Description
System.Int32	tag

Returns

Type	Description
IMaturityMonthYear

GetShort(Int32)

Declaration

public abstract short GetShort(int tag)

Parameters

Type	Name	Description
System.Int32	tag

Returns

Type	Description
System.Int16

GetSignedByte(Int32)

Declaration

public abstract sbyte GetSignedByte(int tag)

Parameters

Type	Name	Description
System.Int32	tag

Returns

Type	Description
System.SByte

GetString(Int32)

Declaration

public abstract string GetString(int tag)

Parameters

Type	Name	Description
System.Int32	tag

Returns

Type	Description
System.String

GetTimestamp(Int32)

Declaration

public abstract ITimestamp GetTimestamp(int tag)

Parameters

Type	Name	Description
System.Int32	tag

Returns

Type	Description
ITimestamp

GetUnsignedInteger(Int32)

Declaration

public abstract uint GetUnsignedInteger(int tag)

Parameters

Type	Name	Description
System.Int32	tag

Returns

Type	Description
System.UInt32

GetUnsignedLong(Int32)

Declaration

public abstract ulong GetUnsignedLong(int tag)

Parameters

Type	Name	Description
System.Int32	tag

Returns

Type	Description
System.UInt64

GetUnsignedShort(Int32)

Declaration

public abstract ushort GetUnsignedShort(int tag)

Parameters

Type	Name	Description
System.Int32	tag

Returns

Type	Description
System.UInt16

GetVariableLengthField(Int32)

Declaration

public abstract IVariableLengthField GetVariableLengthField(int tag)

Parameters

Type	Name	Description
System.Int32	tag

Returns

Type	Description
IVariableLengthField

SetBoolean(Int32, Boolean)

Declaration

public abstract IFieldSet SetBoolean(int tag, bool value)

Parameters

Type	Name	Description
System.Int32	tag
System.Boolean	value

Returns

Type	Description
IFieldSet

SetByte(Int32, Byte)

Declaration

public abstract IFieldSet SetByte(int tag, byte value)

Parameters

Type	Name	Description
System.Int32	tag
System.Byte	value

Returns

Type	Description
IFieldSet

SetByte(Int32, Int32)

Declaration

public abstract IFieldSet SetByte(int tag, int value)

Parameters

Type	Name	Description
System.Int32	tag
System.Int32	value

Returns

Type	Description
IFieldSet

SetBytes(Int32, ReadOnlySpan<Byte>)

Declaration

public abstract IFieldSet SetBytes(int tag, ReadOnlySpan<byte> value)

Parameters

Type	Name	Description
System.Int32	tag
ReadOnlySpan<System.Byte>	value

Returns

Type	Description
IFieldSet

SetChar(Int32, Char)

Declaration

public abstract IFieldSet SetChar(int tag, char value)

Parameters

Type	Name	Description
System.Int32	tag
System.Char	value

Returns

Type	Description
IFieldSet

SetDecimal(Int32, Decimal)

Declaration

public abstract IFieldSet SetDecimal(int tag, decimal value)

Parameters

Type	Name	Description
System.Int32	tag
System.Decimal	value

Returns

Type	Description
IFieldSet

SetEnum<T>(Int32, T)

Declaration

public abstract IFieldSet SetEnum<T>(int tag, T value)

    where T : struct

Parameters

Type	Name	Description
System.Int32	tag
T	value

Returns

Type	Description
IFieldSet

Type Parameters

Name	Description
T

SetGroup(Int32, Int32)

Declaration

public abstract IGroup SetGroup(int tag, int count)

Parameters

Type	Name	Description
System.Int32	tag
System.Int32	count

Returns

Type	Description
IGroup

SetInteger(Int32, Int32)

Declaration

public abstract IFieldSet SetInteger(int tag, int value)

Parameters

Type	Name	Description
System.Int32	tag
System.Int32	value

Returns

Type	Description
IFieldSet

SetLong(Int32, Int64)

Declaration

public abstract IFieldSet SetLong(int tag, long value)

Parameters

Type	Name	Description
System.Int32	tag
System.Int64	value

Returns

Type	Description
IFieldSet

SetShort(Int32, Int16)

Declaration

public abstract IFieldSet SetShort(int tag, short value)

Parameters

Type	Name	Description
System.Int32	tag
System.Int16	value

Returns

Type	Description
IFieldSet

SetShort(Int32, Int32)

Declaration

public abstract IFieldSet SetShort(int tag, int value)

Parameters

Type	Name	Description
System.Int32	tag
System.Int32	value

Returns

Type	Description
IFieldSet

SetSignedByte(Int32, Int32)

Declaration

public abstract IFieldSet SetSignedByte(int tag, int value)

Parameters

Type	Name	Description
System.Int32	tag
System.Int32	value

Returns

Type	Description
IFieldSet

SetSignedByte(Int32, SByte)

Declaration

public abstract IFieldSet SetSignedByte(int tag, sbyte value)

Parameters

Type	Name	Description
System.Int32	tag
System.SByte	value

Returns

Type	Description
IFieldSet

SetString(Int32, String)

Declaration

public abstract IFieldSet SetString(int tag, string value)

Parameters

Type	Name	Description
System.Int32	tag
System.String	value

Returns

Type	Description
IFieldSet

SetToNull(Int32)

Declaration

public abstract IFieldSet SetToNull(int tag)

Parameters

Type	Name	Description
System.Int32	tag

Returns

Type	Description
IFieldSet

SetUnsignedInteger(Int32, UInt32)

Declaration

public abstract IFieldSet SetUnsignedInteger(int tag, uint value)

Parameters

Type	Name	Description
System.Int32	tag
System.UInt32	value

Returns

Type	Description
IFieldSet

SetUnsignedLong(Int32, UInt64)

Declaration

public abstract IFieldSet SetUnsignedLong(int tag, ulong value)

Parameters

Type	Name	Description
System.Int32	tag
System.UInt64	value

Returns

Type	Description
IFieldSet

SetUnsignedShort(Int32, Int32)

Declaration

public abstract IFieldSet SetUnsignedShort(int tag, int value)

Parameters

Type	Name	Description
System.Int32	tag
System.Int32	value

Returns

Type	Description
IFieldSet

SetUnsignedShort(Int32, UInt16)

Declaration

public abstract IFieldSet SetUnsignedShort(int tag, ushort value)

Parameters

Type	Name	Description
System.Int32	tag
System.UInt16	value

Returns

Type	Description
IFieldSet

ToFixString()

Declaration

public abstract string ToFixString()

Returns

Type	Description
System.String

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A string that represents the current object.

ToString(Char)

Declaration

public abstract string ToString(char separator)

Parameters

Type	Name	Description
System.Char	separator

Returns

Type	Description
System.String

Implements

IMessage

IFieldSet

ICloneable