OnixS CME Drop Copy Handler C++ library  5.4.1
API documentation
HandlerSettings Struct Reference

#include <OnixS/CME/DropCopy/HandlerSettings.h>

Public Member Functions

 HandlerSettings ()
 
std::string toString () const
 
- Public Member Functions inherited from InitializationSettings
 InitializationSettings ()
 
std::string toString () const
 

Public Attributes

LogMode logMode
 
std::string logDirectory
 
std::string logFileNamePrefix
 
std::string logExt
 
AdvancedLogOptionSet advancedLogOptions
 
int heartbeatInterval
 
std::string senderCompId
 
std::string targetCompId
 
std::string customKey
 
std::string senderSubId
 
std::string targetSubId
 
std::string senderLocationId
 
bool keepSequenceNumbersAfterLogout
 
std::string networkInterface
 
bool processNextExpectedSeqNumFromCmeLogout
 
- Public Attributes inherited from InitializationSettings
std::string fixEngineConfigFile
 
std::string fixDictionaryFile
 
std::string fixEngineLogDirectory
 
std::string licenseStore
 

Detailed Description

Definition at line 87 of file HandlerSettings.h.

Constructor & Destructor Documentation

Initializes parameters with default values.

Member Function Documentation

std::string toString ( ) const

Returns string representation.

Member Data Documentation

AdvancedLogOptionSet advancedLogOptions

Additional options to control which data is to be logged. Ignored if logging is disabled.

Note
The default value is AdvancedLogOptions::LogEverything.

Definition at line 125 of file HandlerSettings.h.

std::string customKey

FIX session custom key.

Custom key that can be used to distinguish sessions with the same values of the SenderCompID, TargetCompID and the FIX Protocol version.

THe default value is empty string.

Definition at line 158 of file HandlerSettings.h.

int heartbeatInterval

Heartbeat interval in seconds.

Default value is 30 seconds.

Definition at line 130 of file HandlerSettings.h.

bool keepSequenceNumbersAfterLogout

Option to keep sequence numbers after the exchange of Logout (MsgType=5) messages.

The default value is true.

Definition at line 187 of file HandlerSettings.h.

std::string logDirectory

Log files are stored in this directory.

Ignored if logging is disabled.

Note
The default value is "./".

Definition at line 102 of file HandlerSettings.h.

std::string logExt

Log files will use this value as file extension.

Ignored if logging is disabled.

Note
The default value is "log".

Definition at line 118 of file HandlerSettings.h.

std::string logFileNamePrefix

Log files will use this value as filename prefix.

Ignored if logging is disabled.

Note
The default value is "CmeDropCopyHandlerCpp".

Definition at line 110 of file HandlerSettings.h.

LogMode logMode

Specifies whether the Handler should log its events and which of events should be put into the log.

Note
The default value is LogModes::Regular.

Definition at line 94 of file HandlerSettings.h.

std::string networkInterface

Local network interface for CME Session.

Definition at line 190 of file HandlerSettings.h.

bool processNextExpectedSeqNumFromCmeLogout

If true will set the session outgoing sequence number to the NextExpectedMsgSeqNum (tag 789) field value from the CME Logout message.

The default value is false.

Definition at line 196 of file HandlerSettings.h.

std::string senderCompId

FIX session SenderCompID.

This tag consists of 2 subcomponents and a constant: Session ID, Firm ID, and Fault Tolerance Indicator (FTI). Session ID is the left-most 3 characters. The next 3 characters represent Firm ID. The last character is always set to FTI.

Definition at line 138 of file HandlerSettings.h.

std::string senderLocationId

Fix session SenderLocationId.

ISO identifier of message originator's location (i.e. geographic location and/or desk).

The default value is "EN,GB".

Definition at line 182 of file HandlerSettings.h.

std::string senderSubId

Fix session SenderSubID.

Operator ID. Must be unique per Firm ID.

Definition at line 165 of file HandlerSettings.h.

std::string targetCompId

FIX session TargetCompID.

Identifies entity receiving the message (CME).

The default value is "CME".

Definition at line 147 of file HandlerSettings.h.

std::string targetSubId

Fix session TargetSubID.

Identifies platform receiving the message (Globex)

The default value is "G".

Definition at line 174 of file HandlerSettings.h.


The documentation for this struct was generated from the following file: