Class SerializedMessage

Pre-serialized message representation.

Inheritance

object

SerializedMessage

Implements

ICloneable

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

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*, uint)

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
uint	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
bool

Length

Returns the size of the serialized content.

Declaration

public int Length { get; }

Property Value

Type	Description
int	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(int)

Creates the SerializedFieldKey instance that corresponds to the given tag.

Declaration

public SerializedFieldKey AllocateKey(int tag)

Parameters

Type	Name	Description
int	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 instance that is a copy of the current instance.

Declaration

public SerializedMessage Clone()

Returns

Type	Description
SerializedMessage	A new instance 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
bool

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
bool

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
bool

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
bool

CompareType(char)

Declaration

public bool CompareType(char type)

Parameters

Type	Name	Description
char	type

Returns

Type	Description
bool

CompareType(ReadOnlySpan<byte>)

Declaration

public bool CompareType(ReadOnlySpan<byte> type)

Parameters

Type	Name	Description
ReadOnlySpan<byte>	type

Returns

Type	Description
bool

CompareType(ReadOnlySpan<char>)

Declaration

public bool CompareType(ReadOnlySpan<char> type)

Parameters

Type	Name	Description
ReadOnlySpan<char>	type

Returns

Type	Description
bool

CopyTo(byte[], int)

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
int	offset	Starting offset in array

Returns

Type	Description
int	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
int	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()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

Dispose(bool)

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~SerializedMessage()

Declaration

protected ~SerializedMessage()

Find(int)

Finds SerializedFieldRef that corresponds to the given tag.

Declaration

public SerializedFieldRef Find(int tag)

Parameters

Type	Name	Description
int	tag	int number

Returns

Type	Description
SerializedFieldRef	SerializedFieldRef if the corresponding field is present, otherwise - null

Find(int, 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
int	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, bool)

Sets the boolean field value.

Declaration

public SerializedMessage Set(SerializedFieldKey key, bool value)

Parameters

Type	Name	Description
SerializedFieldKey	key	Field reference
bool	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, int)

Sets the integer field value.

Declaration

public SerializedMessage Set(SerializedFieldKey key, int value)

Parameters

Type	Name	Description
SerializedFieldKey	key	Field reference
int	value	Field value

Returns

Type	Description
SerializedMessage

Set(SerializedFieldKey, long)

Sets the long integer field value.

Declaration

public SerializedMessage Set(SerializedFieldKey key, long value)

Parameters

Type	Name	Description
SerializedFieldKey	key	Field key
long	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, float)

Sets the floating point field value.

Declaration

public SerializedMessage Set(SerializedFieldKey key, float value)

Parameters

Type	Name	Description
SerializedFieldKey	key	Field key
float	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, uint)

Sets the unsigned integer field value.

Declaration

public SerializedMessage Set(SerializedFieldKey key, uint value)

Parameters

Type	Name	Description
SerializedFieldKey	key	Field reference
uint	value	Field value

Returns

Type	Description
SerializedMessage

Set(SerializedFieldKey, ulong)

Sets the unsigned long integer field value.

Declaration

public SerializedMessage Set(SerializedFieldKey key, ulong value)

Parameters

Type	Name	Description
SerializedFieldKey	key	Field key
ulong	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, bool)

Sets the boolean field value.

Declaration

public SerializedMessage Set(ref SerializedFieldRef reference, bool value)

Parameters

Type	Name	Description
SerializedFieldRef	reference	Field reference
bool	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, int)

Sets the integer field value.

Declaration

public SerializedMessage Set(ref SerializedFieldRef reference, int value)

Parameters

Type	Name	Description
SerializedFieldRef	reference	Field reference
int	value	Field value

Returns

Type	Description
SerializedMessage

Set(ref SerializedFieldRef, long)

Sets the long integer field value.

Declaration

public SerializedMessage Set(ref SerializedFieldRef reference, long value)

Parameters

Type	Name	Description
SerializedFieldRef	reference	Field reference
long	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, float)

Sets the floating point field value.

Declaration

public SerializedMessage Set(ref SerializedFieldRef reference, float value)

Parameters

Type	Name	Description
SerializedFieldRef	reference	Field key
float	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, uint)

Sets the unsigned integer field value.

Declaration

public SerializedMessage Set(ref SerializedFieldRef reference, uint value)

Parameters

Type	Name	Description
SerializedFieldRef	reference	Field reference
uint	value	Field value

Returns

Type	Description
SerializedMessage

Set(ref SerializedFieldRef, ulong)

Sets the unsigned long integer field value.

Declaration

public SerializedMessage Set(ref SerializedFieldRef reference, ulong value)

Parameters

Type	Name	Description
SerializedFieldRef	reference	Field reference
ulong	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
int	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
int

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

object.ToString()

Implements

ICloneable

IDisposable