Interface IMessageStorage
The common message storage interface.
Inherited Members
Namespace: FixAntenna.FixEngine.Storage
Assembly: FixAntenna.Core.dll
Syntax
public interface IMessageStorage : IDisposable
Methods
AppendMessage(Byte[])
Appends message to storage.
Declaration
void AppendMessage(byte[] message)
Parameters
Type | Name | Description |
---|---|---|
System.Byte[] | message | the message |
Exceptions
Type | Condition |
---|---|
System.IO.IOException | if error occurred. |
AppendMessage(Byte[], Byte[])
Appends message to storage with the given formatted timestampFormatted.
Declaration
void AppendMessage(byte[] timestampFormatted, byte[] message)
Parameters
Type | Name | Description |
---|---|---|
System.Byte[] | timestampFormatted | the message timestampFormatted |
System.Byte[] | message | the message |
Exceptions
Type | Condition |
---|---|
System.IO.IOException | if error occurred. |
AppendMessage(Byte[], Byte[], Int32, Int32)
Appends message to storage with the given formatted timestamp.
Declaration
void AppendMessage(byte[] timestampFormatted, byte[] message, int offset, int length)
Parameters
Type | Name | Description |
---|---|---|
System.Byte[] | timestampFormatted | the message timestamp |
System.Byte[] | message | the message |
System.Int32 | offset | the initial offset |
System.Int32 | length | the length |
Exceptions
Type | Condition |
---|---|
System.IO.IOException | if error occurred. |
AppendMessage(Byte[], Int32, Int32)
Appends message to storage.
Declaration
void AppendMessage(byte[] message, int offset, int length)
Parameters
Type | Name | Description |
---|---|---|
System.Byte[] | message | the message |
System.Int32 | offset | the initial offset |
System.Int32 | length | the length |
Exceptions
Type | Condition |
---|---|
System.IO.IOException | if error occurred. |
BackupStorage(SessionParameters)
Backup the storage.
Declaration
void BackupStorage(SessionParameters sessionParameters)
Parameters
Type | Name | Description |
---|---|---|
SessionParameters | sessionParameters | the session parameters |
Close()
Close the storage.
Declaration
void Close()
Exceptions
Type | Condition |
---|---|
System.IO.IOException | if error occurred. |
Initialize()
Initialize the storage.
Declaration
long Initialize()
Returns
Type | Description |
---|---|
System.Int64 | the next sequence number |
Exceptions
Type | Condition |
---|---|
System.IO.IOException | if error occurred. |
RetrieveMessage(Int64)
Retrieves message from storage.
Declaration
byte[] RetrieveMessage(long seqNumber)
Parameters
Type | Name | Description |
---|---|---|
System.Int64 | seqNumber | the sequence number of message |
Returns
Type | Description |
---|---|
System.Byte[] | the retrieved message |
Exceptions
Type | Condition |
---|---|
System.IO.IOException | if error occurred. |
RetrieveMessages(Int64, Int64, IMessageStorageListener, Boolean)
Retrieves message from storage.
Declaration
void RetrieveMessages(long fromSeqNum, long toSeqNun, IMessageStorageListener listener, bool blocking)
Parameters
Type | Name | Description |
---|---|---|
System.Int64 | fromSeqNum | the from sequence number |
System.Int64 | toSeqNun | the to sequence number |
IMessageStorageListener | listener | the callback listener |
System.Boolean | blocking | if parameter is true, the execution start in current thread context, otherwise in the new thread context. |
Exceptions
Type | Condition |
---|---|
System.IO.IOException | if error occurred. |