Class SerializedMessage

Pre-serialized message representation.

Inheritance
Object
SerializedMessage
Implements
Inherited Members
Namespace: OnixS.Fix
Assembly: OnixS.Fix.Engine.dll
Syntax
public class SerializedMessage : ICloneable, IDisposable

Constructors

SerializedMessage(FlatMessage)

Constructs the instance from the given FlatMessage.

Declaration
public SerializedMessage(FlatMessage source)
Parameters
Type Name Description
FlatMessage source

Source message

SerializedMessage(Message)

Constructs the instance from the given Message.

Declaration
public SerializedMessage(Message source)
Parameters
Type Name Description
Message source

Source message

SerializedMessage(ProtocolVersion, ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, ReadOnlySpan<Byte>)

Declaration
public SerializedMessage(ProtocolVersion protocolVersion, ReadOnlySpan<byte> msgType, ReadOnlySpan<byte> senderCompId, ReadOnlySpan<byte> targetCompId, ReadOnlySpan<byte> rawMessageWithoutHeaderTrailer)
Parameters
Type Name Description
ProtocolVersion protocolVersion
ReadOnlySpan<Byte> msgType
ReadOnlySpan<Byte> senderCompId
ReadOnlySpan<Byte> targetCompId
ReadOnlySpan<Byte> rawMessageWithoutHeaderTrailer

SerializedMessage(ProtocolVersion, ReadOnlySpan<Char>, ReadOnlySpan<Char>, ReadOnlySpan<Char>, ReadOnlySpan<Byte>)

Declaration
public SerializedMessage(ProtocolVersion version, ReadOnlySpan<char> type, ReadOnlySpan<char> senderCompId, ReadOnlySpan<char> targetCompId, ReadOnlySpan<byte> rawMessageWithoutHeaderTrailer)
Parameters
Type Name Description
ProtocolVersion version
ReadOnlySpan<Char> type
ReadOnlySpan<Char> senderCompId
ReadOnlySpan<Char> targetCompId
ReadOnlySpan<Byte> rawMessageWithoutHeaderTrailer

SerializedMessage(ProtocolVersion, ReadOnlySpan<Char>, ReadOnlySpan<Char>, ReadOnlySpan<Char>, ReadOnlySpan<Char>)

Declaration
public SerializedMessage(ProtocolVersion version, ReadOnlySpan<char> type, ReadOnlySpan<char> senderCompId, ReadOnlySpan<char> targetCompId, ReadOnlySpan<char> rawMessageWithoutHeaderTrailer)
Parameters
Type Name Description
ProtocolVersion version
ReadOnlySpan<Char> type
ReadOnlySpan<Char> senderCompId
ReadOnlySpan<Char> targetCompId
ReadOnlySpan<Char> rawMessageWithoutHeaderTrailer

SerializedMessage(SerializedMessage)

Constructs the copy of existing SerializedMessage.

Declaration
public SerializedMessage(SerializedMessage other)
Parameters
Type Name Description
SerializedMessage other

Source message

SerializedMessage(Byte*, UInt32)

Constructs the instance from the given plain FIX (tag=value) string.

Declaration
public SerializedMessage(byte *serialMessage, uint serialMessageLength)
Parameters
Type Name Description
Byte* serialMessage

A plain byte-width FIX (tag=value) string
UInt32 serialMessageLength

Length of serial message

SerializedMessage(ReadOnlySpan<Byte>)

Constructs the instance from the given plain FIX (tag=value) string.

Declaration
public SerializedMessage(ReadOnlySpan<byte> serialMessage)
Parameters
Type Name Description
ReadOnlySpan<Byte> serialMessage

A plain FIX (tag=value) string

SerializedMessage(ReadOnlySpan<Char>)

Constructs the instance from the given plain FIX (tag=value) string.

Declaration
public SerializedMessage(ReadOnlySpan<char> serialMessage)
Parameters
Type Name Description
ReadOnlySpan<Char> serialMessage

A plain FIX (tag=value) string

Properties

Bytes

Returns the content of the serialized message.

Declaration
public ReadOnlySpan<byte> Bytes { get; }
Property Value
Type Description
ReadOnlySpan<Byte>

Content of the serialized message

IsDisposed

True if SerializedMessage is already disposed.

Declaration
public bool IsDisposed { get; }
Property Value
Type Description
Boolean

Length

Returns the size of the serialized content.

Declaration
public int Length { get; }
Property Value
Type Description
Int32

Size of the serialized content

Methods

AllocateKey(SerializedFieldRef)

Creates the SerializedFieldKey instance that corresponds to the given SerializedFieldRef.

Declaration
public SerializedFieldKey AllocateKey(SerializedFieldRef reference)
Parameters
Type Name Description
SerializedFieldRef reference

Field reference
Returns
Type Description
SerializedFieldKey

AllocateKey(Int32)

Creates the SerializedFieldKey instance that corresponds to the given tag.

Declaration
public SerializedFieldKey AllocateKey(int tag)
Parameters
Type Name Description
Int32 tag

int number
Returns
Type Description
SerializedFieldKey

Chars()

Returns the content of the serialized message.

Declaration
public string Chars()
Returns
Type Description
String

Content of the serialized message

Clone()

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

Declaration
public SerializedMessage Clone()
Returns
Type Description
SerializedMessage

A new SerializedMessage that is a copy of the current instance

CompareFieldValue(SerializedFieldKey, ReadOnlySpan<Byte>)

Declaration
public bool CompareFieldValue(SerializedFieldKey key, ReadOnlySpan<byte> value)
Parameters
Type Name Description
SerializedFieldKey key
ReadOnlySpan<Byte> value
Returns
Type Description
Boolean

CompareFieldValue(SerializedFieldKey, ReadOnlySpan<Char>)

Declaration
public bool CompareFieldValue(SerializedFieldKey key, ReadOnlySpan<char> value)
Parameters
Type Name Description
SerializedFieldKey key
ReadOnlySpan<Char> value
Returns
Type Description
Boolean

CompareFieldValue(SerializedFieldRef, ReadOnlySpan<Byte>)

Declaration
public bool CompareFieldValue(SerializedFieldRef reference, ReadOnlySpan<byte> value)
Parameters
Type Name Description
SerializedFieldRef reference
ReadOnlySpan<Byte> value
Returns
Type Description
Boolean

CompareFieldValue(SerializedFieldRef, ReadOnlySpan<Char>)

Declaration
public bool CompareFieldValue(SerializedFieldRef reference, ReadOnlySpan<char> value)
Parameters
Type Name Description
SerializedFieldRef reference
ReadOnlySpan<Char> value
Returns
Type Description
Boolean

CompareType(Char)

Declaration
public bool CompareType(char type)
Parameters
Type Name Description
Char type
Returns
Type Description
Boolean

CompareType(ReadOnlySpan<Byte>)

Declaration
public bool CompareType(ReadOnlySpan<byte> type)
Parameters
Type Name Description
ReadOnlySpan<Byte> type
Returns
Type Description
Boolean

CompareType(ReadOnlySpan<Char>)

Declaration
public bool CompareType(ReadOnlySpan<char> type)
Parameters
Type Name Description
ReadOnlySpan<Char> type
Returns
Type Description
Boolean

CopyTo(Byte[], Int32)

Copies the contents to the given byte array.

Declaration
public int CopyTo(byte[] buffer, int offset)
Parameters
Type Name Description
Byte[] buffer

Byte array to serialize the message content to
Int32 offset

Starting offset in array
Returns
Type Description
Int32

The number of copied bytes if the given buffer is large enough. Otherwise - a negative number, the absolute value of which is equal to the required size of the buffer.

CopyTo(Span<Byte>)

Copies the contents to the given byte span.

Declaration
public int CopyTo(Span<byte> buffer)
Parameters
Type Name Description
Span<Byte> buffer

Byte span to serialize the message content to
Returns
Type Description
Int32

The number of copied bytes if the given buffer is large enough. Otherwise - a negative number, the absolute value of which is equal to the required size of the buffer.

Dispose()

Declaration
public void Dispose()

Dispose(Boolean)

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
Boolean disposing

Finalize()

Declaration
protected void Finalize()

Find(Int32)

Finds SerializedFieldRef that corresponds to the given tag.

Declaration
public SerializedFieldRef Find(int tag)
Parameters
Type Name Description
Int32 tag

int number
Returns
Type Description
SerializedFieldRef

SerializedFieldRef if the corresponding field is present, otherwise - null

Find(Int32, SerializedFieldRef)

Finds SerializedFieldRef that corresponds to the given tag and is located further than the given SerializedFieldRef instance.

Declaration
public SerializedFieldRef Find(int tag, SerializedFieldRef findAfter)
Parameters
Type Name Description
Int32 tag

int number
SerializedFieldRef findAfter

SerializedFieldRef instance to start the search after
Returns
Type Description
SerializedFieldRef

SerializedFieldRef if the corresponding field is present, otherwise - null

Get(SerializedFieldKey)

Returns the field value by the given field key.

Declaration
public string Get(SerializedFieldKey key)
Parameters
Type Name Description
SerializedFieldKey key

Field key
Returns
Type Description
String

Get(SerializedFieldKey, StringBuilder)

Appends the field value by the given field key to StringBuilder.

Declaration
public SerializedMessage Get(SerializedFieldKey key, StringBuilder result)
Parameters
Type Name Description
SerializedFieldKey key

Field key
StringBuilder result

Target StringBuilder instance
Returns
Type Description
SerializedMessage

Get(SerializedFieldRef)

Returns the field value by the given field reference.

Declaration
public string Get(SerializedFieldRef reference)
Parameters
Type Name Description
SerializedFieldRef reference

Field reference
Returns
Type Description
String

Get(SerializedFieldRef, StringBuilder)

Appends the field value by the given field reference to StringBuilder.

Declaration
public SerializedMessage Get(SerializedFieldRef reference, StringBuilder result)
Parameters
Type Name Description
SerializedFieldRef reference

Field reference
StringBuilder result

Target StringBuilder instance
Returns
Type Description
SerializedMessage

Reset(FlatMessage)

Resets content of SerializedMessage using the given FlatMessage.

Declaration
public void Reset(FlatMessage source)
Parameters
Type Name Description
FlatMessage source

Source message

Reset(Message)

Resets content of SerializedMessage using the given Message.

Declaration
public void Reset(Message source)
Parameters
Type Name Description
Message source

Source message

Reset(SerializedMessage)

Resets content of SerializedMessage using the given SerializedMessage.

Declaration
public void Reset(SerializedMessage other)
Parameters
Type Name Description
SerializedMessage other

Source message

Set(SerializedFieldKey, HighResolutionTimeSpan, TimeSpanFormat)

Sets the TimeSpan field value.

Declaration
public SerializedMessage Set(SerializedFieldKey key, HighResolutionTimeSpan value, TimeSpanFormat format)
Parameters
Type Name Description
SerializedFieldKey key

Field key
HighResolutionTimeSpan value

Field value
TimeSpanFormat format

TimeSpan format
Returns
Type Description
SerializedMessage

Set(SerializedFieldKey, HighResolutionTimestamp, TimestampFormat)

Sets the HighResolutionTimestamp field value.

Declaration
public SerializedMessage Set(SerializedFieldKey key, HighResolutionTimestamp value, TimestampFormat format)
Parameters
Type Name Description
SerializedFieldKey key

Field key
HighResolutionTimestamp value

Field value
TimestampFormat format

Timestamp format
Returns
Type Description
SerializedMessage

Set(SerializedFieldKey, Boolean)

Sets the boolean field value.

Declaration
public SerializedMessage Set(SerializedFieldKey key, bool value)
Parameters
Type Name Description
SerializedFieldKey key

Field reference
Boolean value

Field value
Returns
Type Description
SerializedMessage

Set(SerializedFieldKey, Char)

Sets the character field value.

Declaration
public SerializedMessage Set(SerializedFieldKey key, char value)
Parameters
Type Name Description
SerializedFieldKey key

Field key
Char value

Field value
Returns
Type Description
SerializedMessage

Set(SerializedFieldKey, DateTime)

Sets the DateTime field value.

Declaration
public SerializedMessage Set(SerializedFieldKey key, DateTime value)
Parameters
Type Name Description
SerializedFieldKey key

Field key
DateTime value

Field value
Returns
Type Description
SerializedMessage

Set(SerializedFieldKey, DateTime, TimestampFormat)

Sets the DateTime field value.

Declaration
public SerializedMessage Set(SerializedFieldKey key, DateTime value, TimestampFormat format)
Parameters
Type Name Description
SerializedFieldKey key

Field key
DateTime value

Field value
TimestampFormat format

Timestamp format
Returns
Type Description
SerializedMessage

Set(SerializedFieldKey, Decimal)

Sets the fixed point field value.

Declaration
public SerializedMessage Set(SerializedFieldKey key, decimal value)
Parameters
Type Name Description
SerializedFieldKey key

Field key
Decimal value

Field value
Returns
Type Description
SerializedMessage

Set(SerializedFieldKey, Double)

Sets the floating point field value of double precision.

Declaration
public SerializedMessage Set(SerializedFieldKey key, double value)
Parameters
Type Name Description
SerializedFieldKey key

Field key
Double value

Field value
Returns
Type Description
SerializedMessage

Set(SerializedFieldKey, Int32)

Sets the integer field value.

Declaration
public SerializedMessage Set(SerializedFieldKey key, int value)
Parameters
Type Name Description
SerializedFieldKey key

Field reference
Int32 value

Field value
Returns
Type Description
SerializedMessage

Set(SerializedFieldKey, Int64)

Sets the long integer field value.

Declaration
public SerializedMessage Set(SerializedFieldKey key, long value)
Parameters
Type Name Description
SerializedFieldKey key

Field key
Int64 value

Field value
Returns
Type Description
SerializedMessage

Set(SerializedFieldKey, ReadOnlySpan<Byte>)

Sets the byte-width string field value.

Declaration
public SerializedMessage Set(SerializedFieldKey key, ReadOnlySpan<byte> value)
Parameters
Type Name Description
SerializedFieldKey key

Field key
ReadOnlySpan<Byte> value

Field value
Returns
Type Description
SerializedMessage

Set(SerializedFieldKey, ReadOnlySpan<Char>)

Sets the string field value.

Declaration
public SerializedMessage Set(SerializedFieldKey key, ReadOnlySpan<char> value)
Parameters
Type Name Description
SerializedFieldKey key

Field key
ReadOnlySpan<Char> value

Field value
Returns
Type Description
SerializedMessage

Set(SerializedFieldKey, Single)

Sets the floating point field value.

Declaration
public SerializedMessage Set(SerializedFieldKey key, float value)
Parameters
Type Name Description
SerializedFieldKey key

Field key
Single value

Field value
Returns
Type Description
SerializedMessage

Set(SerializedFieldKey, StringBuilder)

Sets the string field value.

Declaration
public SerializedMessage Set(SerializedFieldKey key, StringBuilder value)
Parameters
Type Name Description
SerializedFieldKey key

Field key
StringBuilder value

Field value
Returns
Type Description
SerializedMessage

Set(SerializedFieldKey, TimeSpan)

Sets the TimeSpan field value using the OnixS.Core.HHMMSSmsec format.

Declaration
public SerializedMessage Set(SerializedFieldKey key, TimeSpan value)
Parameters
Type Name Description
SerializedFieldKey key

Field key
TimeSpan value

Field value
Returns
Type Description
SerializedMessage

Set(SerializedFieldKey, TimeSpan, TimeSpanFormat)

Sets the HighResolutionTimeSpan field value.

Declaration
public SerializedMessage Set(SerializedFieldKey key, TimeSpan value, TimeSpanFormat format)
Parameters
Type Name Description
SerializedFieldKey key

Field key
TimeSpan value

Field value
TimeSpanFormat format

TimeSpan format
Returns
Type Description
SerializedMessage

Set(SerializedFieldKey, UInt32)

Sets the unsigned integer field value.

Declaration
public SerializedMessage Set(SerializedFieldKey key, uint value)
Parameters
Type Name Description
SerializedFieldKey key

Field reference
UInt32 value

Field value
Returns
Type Description
SerializedMessage

Set(SerializedFieldKey, UInt64)

Sets the unsigned long integer field value.

Declaration
public SerializedMessage Set(SerializedFieldKey key, ulong value)
Parameters
Type Name Description
SerializedFieldKey key

Field key
UInt64 value

Field value
Returns
Type Description
SerializedMessage

Set(ref SerializedFieldRef, HighResolutionTimeSpan, TimeSpanFormat)

Sets the TimeSpan field value.

Declaration
public SerializedMessage Set(ref SerializedFieldRef reference, HighResolutionTimeSpan value, TimeSpanFormat format)
Parameters
Type Name Description
SerializedFieldRef reference

Field key
HighResolutionTimeSpan value

Field value
TimeSpanFormat format

TimeSpan format
Returns
Type Description
SerializedMessage

Set(ref SerializedFieldRef, HighResolutionTimestamp, TimestampFormat)

Sets the HighResolutionTimestamp field value.

Declaration
public SerializedMessage Set(ref SerializedFieldRef reference, HighResolutionTimestamp value, TimestampFormat format)
Parameters
Type Name Description
SerializedFieldRef reference

Field key
HighResolutionTimestamp value

Field value
TimestampFormat format

Timestamp format
Returns
Type Description
SerializedMessage

Set(ref SerializedFieldRef, Boolean)

Sets the boolean field value.

Declaration
public SerializedMessage Set(ref SerializedFieldRef reference, bool value)
Parameters
Type Name Description
SerializedFieldRef reference

Field reference
Boolean value

Field value
Returns
Type Description
SerializedMessage

Set(ref SerializedFieldRef, Char)

Sets the character field value.

Declaration
public SerializedMessage Set(ref SerializedFieldRef reference, char value)
Parameters
Type Name Description
SerializedFieldRef reference

Field key
Char value

Field value
Returns
Type Description
SerializedMessage

Set(ref SerializedFieldRef, DateTime)

Sets the DateTime field value.

Declaration
public SerializedMessage Set(ref SerializedFieldRef reference, DateTime value)
Parameters
Type Name Description
SerializedFieldRef reference

Field key
DateTime value

Field value
Returns
Type Description
SerializedMessage

Set(ref SerializedFieldRef, DateTime, TimestampFormat)

Sets the DateTime field value.

Declaration
public SerializedMessage Set(ref SerializedFieldRef reference, DateTime value, TimestampFormat format)
Parameters
Type Name Description
SerializedFieldRef reference

Field key
DateTime value

Field value
TimestampFormat format

Timestamp format
Returns
Type Description
SerializedMessage

Set(ref SerializedFieldRef, Decimal)

Sets the fixed point field value.

Declaration
public SerializedMessage Set(ref SerializedFieldRef reference, decimal value)
Parameters
Type Name Description
SerializedFieldRef reference

Field key
Decimal value

Field value
Returns
Type Description
SerializedMessage

Set(ref SerializedFieldRef, Double)

Sets the floating point field value of double precision.

Declaration
public SerializedMessage Set(ref SerializedFieldRef reference, double value)
Parameters
Type Name Description
SerializedFieldRef reference

Field key
Double value

Field value
Returns
Type Description
SerializedMessage

Set(ref SerializedFieldRef, Int32)

Sets the integer field value.

Declaration
public SerializedMessage Set(ref SerializedFieldRef reference, int value)
Parameters
Type Name Description
SerializedFieldRef reference

Field reference
Int32 value

Field value
Returns
Type Description
SerializedMessage

Set(ref SerializedFieldRef, Int64)

Sets the long integer field value.

Declaration
public SerializedMessage Set(ref SerializedFieldRef reference, long value)
Parameters
Type Name Description
SerializedFieldRef reference

Field reference
Int64 value

Field value
Returns
Type Description
SerializedMessage

Set(ref SerializedFieldRef, ReadOnlySpan<Byte>)

Sets the byte-width string field value.

Declaration
public SerializedMessage Set(ref SerializedFieldRef reference, ReadOnlySpan<byte> value)
Parameters
Type Name Description
SerializedFieldRef reference

Field key
ReadOnlySpan<Byte> value

Field value
Returns
Type Description
SerializedMessage

Set(ref SerializedFieldRef, ReadOnlySpan<Char>)

Sets the string field value.

Declaration
public SerializedMessage Set(ref SerializedFieldRef reference, ReadOnlySpan<char> value)
Parameters
Type Name Description
SerializedFieldRef reference

Field key
ReadOnlySpan<Char> value

Field value
Returns
Type Description
SerializedMessage

Set(ref SerializedFieldRef, Single)

Sets the floating point field value.

Declaration
public SerializedMessage Set(ref SerializedFieldRef reference, float value)
Parameters
Type Name Description
SerializedFieldRef reference

Field key
Single value

Field value
Returns
Type Description
SerializedMessage

Set(ref SerializedFieldRef, StringBuilder)

Sets the string field value.

Declaration
public SerializedMessage Set(ref SerializedFieldRef reference, StringBuilder value)
Parameters
Type Name Description
SerializedFieldRef reference

Field key
StringBuilder value

Field value
Returns
Type Description
SerializedMessage

Set(ref SerializedFieldRef, TimeSpan)

Sets the TimeSpan field value using the OnixS.Core.HHMMSSmsec format.

Declaration
public SerializedMessage Set(ref SerializedFieldRef reference, TimeSpan value)
Parameters
Type Name Description
SerializedFieldRef reference

Field key
TimeSpan value

Field value
Returns
Type Description
SerializedMessage

Set(ref SerializedFieldRef, TimeSpan, TimeSpanFormat)

Sets the HighResolutionTimeSpan field value.

Declaration
public SerializedMessage Set(ref SerializedFieldRef reference, TimeSpan value, TimeSpanFormat format)
Parameters
Type Name Description
SerializedFieldRef reference

Field key
TimeSpan value

Field value
TimeSpanFormat format

TimeSpan format
Returns
Type Description
SerializedMessage

Set(ref SerializedFieldRef, UInt32)

Sets the unsigned integer field value.

Declaration
public SerializedMessage Set(ref SerializedFieldRef reference, uint value)
Parameters
Type Name Description
SerializedFieldRef reference

Field reference
UInt32 value

Field value
Returns
Type Description
SerializedMessage

Set(ref SerializedFieldRef, UInt64)

Sets the unsigned long integer field value.

Declaration
public SerializedMessage Set(ref SerializedFieldRef reference, ulong value)
Parameters
Type Name Description
SerializedFieldRef reference

Field reference
UInt64 value

Field value
Returns
Type Description
SerializedMessage

Size()

Returns the size of the serialized content.

Declaration
[Obsolete("Use the Length property instead")]
public int Size()
Returns
Type Description
Int32

Size of the serialized content

ToBytes(Span<Byte>)

Declaration
[Obsolete("Use CopyTo(buffer) method instead")]
public int ToBytes(Span<byte> buffer)
Parameters
Type Name Description
Span<Byte> buffer
Returns
Type Description
Int32

ToString()

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Explicit Interface Implementations

ICloneable.Clone()

Declaration
object ICloneable.Clone()
Returns
Type Description
Object

Implements