Class SessionSettings

The Handler configuration settings.

Inheritance

object

SessionSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: OnixS.Cme.ILink3

Assembly: OnixS.Cme.ILink3.dll

Syntax

public class SessionSettings

Fields

UseDefaultOperatingSystemBufferSize

The default operating system value of the TCP buffer size.

Declaration

public const int UseDefaultOperatingSystemBufferSize = -1

Field Value

Type	Description
int

Properties

AccessKey

Declaration

public string AccessKey { get; set; }

Property Value

Type	Description
string

DecoderLibraryPath

Path to generated decoder library assembly.

Declaration

public string DecoderLibraryPath { get; set; }

Property Value

Type	Description
string

FileBasedStorageSegmentSize

Maximum size of a single .summary file in bytes. The default value is FileBasedStorageSegmentSize. The property key is FileBasedStorageSegmentSize.

Declaration

public long FileBasedStorageSegmentSize { get; set; }

Property Value

Type	Description
long

FirmId

Declaration

public string FirmId { get; set; }

Property Value

Type	Description
string

IgnoreFileBasedStorageIntegrityErrors

Ignore File Bases Storage integrity errors. The default value is IgnoreFileBasedStorageIntegrityErrors. The property key is IgnoreFileBasedStorageIntegrityErrors.

Declaration

public bool IgnoreFileBasedStorageIntegrityErrors { get; set; }

Property Value

Type	Description
bool	Ignore File Bases Storage integrity errors

KeepAliveInterval

The longest time in milliseconds the client system can remain silent before sending a keep alive message.

Allowed range is between 5000-60000. Any value outside this range will be rejected.

If no message is sent from customer after 1 interval lapses, CME will send a Sequence message indicating that one keep alive interval from customer has lapsed. If still no response is sent from the customer and the second keep alive interval lapses, the session will be terminated.

Declaration

public int KeepAliveInterval { get; set; }

Property Value

Type	Description
int

LicenseAlertingDaysBeforeExpiration

The number of days to alert before the license expiration.

If the number of remaining license days is less or equal to this number then the warning will be reported to the Handler's log and Warning event will be invoked. The verification is performed during the following events: Handler initialization and Connect(string, int) calls.

The default value is LicenseAlertingDaysBeforeExpiration. The property key is LicenseAlertingDaysBeforeExpiration.

Declaration

public int LicenseAlertingDaysBeforeExpiration { get; set; }

Property Value

Type	Description
int	The number of days to alert before the license expiration.

LicenseStore

The path(s) to the folder(s) that contains the license file(s). The symbol '|' is used as a path delimiter.

The default value is LicenseStore. The property key is LicenseStore.

Declaration

public string LicenseStore { get; set; }

Property Value

Type	Description
string

LicenseStores

Paths to folders that contain license files.

The default value is LicenseStore. The property key is LicenseStore.

Declaration

public List<string> LicenseStores { get; }

Property Value

Type	Description
List<string>

LicenseString

The string that contains the license file content.

The default value is LicenseString. The property key is LicenseString.

Declaration

public string LicenseString { get; set; }

Property Value

Type	Description
string

LoadDecoderLibrary

Get or set if the handler should load existing decoding library or create a new one.

Declaration

public bool LoadDecoderLibrary { get; set; }

Property Value

Type	Description
bool

LocalNetworkInterface

The network interface for establishing the TCP connection as an Initiator. The default value is LocalNetworkInterface The property key is LocalNetworkInterface.

Declaration

public IPAddress LocalNetworkInterface { get; set; }

Property Value

Type	Description
IPAddress	The network interface for establishing the TCP connection as an Initiator

See Also

LocalNetworkInterface

LocalTimeUsage

Use the local time in Handler events and log files. The default value is LocalTimeUsage. The property key is LocalTimeUsage.

Declaration

public bool LocalTimeUsage { get; set; }

Property Value

Type	Description
bool	Use the local time in Handler events and log files

LogBeforeSending

Option to switch on/off logging of outbound messages before/after sending. By default, the logging of an outgoing message to the session storage is performed before sending to the wire. This is more reliable because we guarantee that an outgoing message is stored before going to the counterparty and if the application is shut down after sending, for some reasons, the sent message can be resent afterward. However, this approach adds the logging latency to the Handler sending latency. As a result, it increases the tick-to-trade latency. When the latency is more important, one can switch off the logging before sending, by setting the OnixS::FIX::Session::logBeforeSending option to false. In this case, the logging of outgoing messages to the session storage will be performed after sending to the wire. This way, one can exclude the logging latency from the Handler sending latency and as a result, decrease the tick-to-trade latency.

Declaration

public bool LogBeforeSending { get; set; }

Property Value

Type	Description
bool

MarketSegmentConfig

Declaration

public Dictionary<int, ConfigEntry> MarketSegmentConfig { get; set; }

Property Value

Type	Description
Dictionary<int, ConfigEntry>

MessageGrouping

Message sending grouping. The default value is MessageGrouping. The property key is MessageGrouping.

Declaration

public int MessageGrouping { get; set; }

Property Value

Type	Description
int	Value 0 means the default grouping - the messages will be sent ASAP and pending messages (if any) will be grouped until reaching the TCP buffer size. Value 1 means the messages will be sent ASAP and will never be grouped. Value 2 (or greater) means the messages will be sent ASAP and pending messages will be grouped maximum by 2 (or greater).

ReasonableTransmissionTime

Reasonable transmission time as % from the heartbeat interval. The default value is ReasonableTransmissionTime. The property key is ReasonableTransmissionTime.

Declaration

public int ReasonableTransmissionTime { get; set; }

Property Value

Type	Description
int	Reasonable transmission time as % from the heartbeat interval

ReceiveBufferSize

TCP socket receive buffer size allocated to FIXP connection, in bytes. The default value is ReceiveBufferSize. The property key is ReceiveBufferSize.

Declaration

public int ReceiveBufferSize { get; set; }

Property Value

Type	Description
int	TCP socket receive buffer size in bytes

See Also

UseDefaultOperatingSystemBufferSize

ReceiveSpinningTimeout

The non-blocking receive spinning timeout (in microseconds) before the receiving thread enters into the blocking wait mode. Should not be greater than 1 sec. (the minimal KeepAliveInterval interval). The default value is ReceiveSpinningTimeout. The property key is ReceiveSpinningTimeout.

Declaration

public int ReceiveSpinningTimeout { get; set; }

Property Value

Type	Description
int	Receive spinning timeout (in microseconds)

ReconnectAttempts

Number of attempts to restore the telecommunication link. The default value is ReconnectAttempts. The property key is ReconnectAttempts.

Declaration

public int ReconnectAttempts { get; set; }

Property Value

Type	Description
int	Number of attempts to restore the telecommunication link

ReconnectInterval

Time interval between attempts to restore the telecommunication link (in seconds). The default value is ReconnectInterval. The property key is ReconnectInterval.

Declaration

public int ReconnectInterval { get; set; }

Property Value

Type	Description
int	Time interval between attempts to restore the telecommunication link (in seconds)

SecretKey

Declaration

public string SecretKey { get; set; }

Property Value

Type	Description
string

SendBufferSize

TCP socket send buffer size allocated to FIXP connection, in bytes. The default value is SendBufferSize. The property key is SendBufferSize.

Declaration

public int SendBufferSize { get; set; }

Property Value

Type	Description
int	TCP socket send buffer size in bytes

See Also

UseDefaultOperatingSystemBufferSize

SendQueueMaxSize

Sender queue maximum size in bytes. The default value is SendQueueMaxSize. The property key is SendQueueMaxSize.

Declaration

public int SendQueueMaxSize { get; set; }

Property Value

Type	Description
int	TCP socket send buffer size in bytes

SendSpinningTimeout

The send spinning timeout (in microseconds) of the Send(IMessage) method to wait for the socket sending buffer availability in the spin loop mode before placing the message to the outgoing queue (to be sent later by the sending thread). Should not be greater than 1 sec (the minimal Heartbeat interval). The default value is SendSpinningTimeout. The property key is SendSpinningTimeout.

Declaration

public int SendSpinningTimeout { get; set; }

Property Value

Type	Description
int	The send spinning timeout (in microseconds)

SentMessagesQueueMaxSize

Number of messages available via the FindSentMessage(int) method. The default value is SentMessagesQueueMaxSize. The property key is SentMessagesQueueMaxSize.

Declaration

public int SentMessagesQueueMaxSize { get; set; }

Property Value

Type	Description
int

SessionId

Session ID.

Declaration

public string SessionId { get; set; }

Property Value

Type	Description
string

StorageDirectory

Inbound and outbound FIX messages and session's state data are stored in this directory. The default value is StorageDirectory. The property key is StorageDirectory.

Declaration

public string StorageDirectory { get; set; }

Property Value

Type	Description
string	Storage directory

TcpNoDelay

Improve latency at the expense of throughput (disable/enable Nagle's algorithm). The default value is TcpNoDelay. The property key is TcpNoDelay.

Declaration

public bool TcpNoDelay { get; set; }

Property Value

Type	Description
bool	Improve latency at the expense of throughput (disable/enable Nagle's algorithm)

See Also

TcpNoDelay

TemplatesFilePath

Path to the SBE templates file. The default value is TemplatesFilePath. The property key is TemplatesFilePath.

Declaration

public string TemplatesFilePath { get; set; }

Property Value

Type	Description
string	Storage directory

TradingSystemName

Declaration

public string TradingSystemName { get; set; }

Property Value

Type	Description
string

TradingSystemVendor

Declaration

public string TradingSystemVendor { get; set; }

Property Value

Type	Description
string

TradingSystemVersion

Declaration

public string TradingSystemVersion { get; set; }

Property Value

Type	Description
string

UpdateSendingTime

Update the SendingTime (52) field in the outgoing message even if it is already set. The default value is UpdateSendingTime. The property key is UpdateSendingTime.

Declaration

public bool UpdateSendingTime { get; set; }

Property Value

Type	Description
bool	Update the SendingTime (52) field in the outgoing message if it is already set

See Also

UpdateSendingTime

Methods

Clone()

Declaration

public SessionSettings Clone()

Returns

Type	Description
SessionSettings

LoadFromConfigurationFile(string)

Loads configuration settings from the .NET application configuration file or from the given XML or JSON configuration file.

Declaration

public void LoadFromConfigurationFile(string configFileName = "")

Parameters

Type	Name	Description
string	configFileName	XML or JSON configuration file name. If the parameter is empty, then the .NET application configuration file is used.

Exceptions

Type	Condition
EngineException	Configurations settings cannot be loaded.

LoadFromConfigurationString(string)

Loads configuration settings from the given XML or JSON configuration string.

Declaration

public void LoadFromConfigurationString(string configString)

Parameters

Type	Name	Description
string	configString	XML or JSON configuration string.

Exceptions

Type	Condition
EngineException	Configurations settings cannot be loaded.

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()

Validate()

Checks that all required fields are set.

Declaration

public void Validate()