OnixS C++ FIX Engine  4.9.0
API Documentation
EngineSettings Class Reference

#include <OnixS/FIXEngine/FIX/EngineSettings.h>

Public Member Functions

 EngineSettings ()
 
 EngineSettings (const std::string &configuration)
 
 EngineSettings (const EngineSettings &)
 
void loadFromConfigFile (const std::string &configFile)
 
 ~EngineSettings ()
 
EngineSettingsoperator= (const EngineSettings &)
 
EngineSettingscreateEngineLogFile (bool value)
 
bool createEngineLogFile () const
 
EngineSettingsdictionaryFile (const std::string &value)
 
const std::string & dictionaryFile () const
 
EngineSettingsdialectString (const std::string &value)
 
const std::string & dialectString () const
 
EngineSettingslistenPort (int value)
 
int listenPort () const
 
EngineSettingslistenPorts (const ListenPorts &value)
 
const ListenPortslistenPorts () const
 
const LocalNetworkInterfaceslocalNetworkInterface () const
 
EngineSettingslocalNetworkInterface (const LocalNetworkInterfaces &)
 
EngineSettingslocalNetworkInterface (const LocalNetworkInterface &)
 
ThreadingModel::Enum threadingModel () const
 
EngineSettingsthreadingModel (ThreadingModel::Enum value)
 
bool useSpinLock () const
 
EngineSettingsuseSpinLock (bool value)
 
EngineSettingsthreadPoolSize (int size)
 
int threadPoolSize () const
 
EngineSettingslicenseFile (const std::string &value)
 
const std::string & licenseFile () const
 
EngineSettingslicenseStore (const std::string &value)
 
const std::string & licenseStore () const
 
EngineSettingslicenseString (const std::string &value)
 
const std::string & licenseString () const
 
unsigned licenseAlertingDaysBeforeExpiration ()
 
EngineSettingslicenseAlertingDaysBeforeExpiration (unsigned value)
 
EngineSettingslogDirectory (const std::string &value)
 
const std::string & logDirectory () const
 
const std::string & logFileName () const
 
EngineSettingslogFileName (const std::string &value)
 
bool logInboundMessages () const
 
EngineSettingslogInboundMessages (bool value)
 
bool logOutboundMessages () const
 
EngineSettingslogOutboundMessages (bool value)
 
bool logBeforeSending () const
 
EngineSettingslogBeforeSending (bool value)
 
bool localTimeUsage () const
 
EngineSettingslocalTimeUsage (bool value)
 
EngineSettingsprocessDeliverToCompId (bool value)
 
bool processDeliverToCompId () const
 
EngineSettingsreasonableTransmissionTime (int value)
 
int reasonableTransmissionTime () const
 
EngineSettingsreconnectAttempts (int value)
 
int reconnectAttempts () const
 
EngineSettingsreconnectInterval (int value)
 
int reconnectInterval () const
 
EngineSettingsresendingQueueSize (size_t value)
 
size_t resendingQueueSize () const
 
EngineSettingsresendRequestMaximumRange (int value)
 
int resendRequestMaximumRange () const
 
int receiveBufferSize () const
 
EngineSettingsreceiveBufferSize (int value)
 
int sendBufferSize () const
 
EngineSettingssendBufferSize (int value)
 
EngineSettingssendLogoutOnException (bool value)
 
bool sendLogoutOnException () const
 
EngineSettingssendLogoutOnInvalidLogon (bool value)
 
bool sendLogoutOnInvalidLogon () const
 
EngineSettingssslCertificateFile (const std::string &value)
 
const std::string & sslCertificateFile () const
 
EngineSettingssslPrivateKeyFile (const std::string &value)
 
const std::string & sslPrivateKeyFile () const
 
EngineSettingssslPrivateKeyPassword (const Cryptography::SecureString &value)
 
Cryptography::SecureString sslPrivateKeyPassword () const
 
EngineSettingssslListenPort (int value)
 
int sslListenPort () const
 
EngineSettingssslListenPorts (const ListenPorts &value)
 
const ListenPortssslListenPorts () const
 
const LocalNetworkInterfacessslLocalInterface () const
 
EngineSettingssslLocalInterface (const LocalNetworkInterfaces &)
 
EngineSettingssslVerifyPeer (bool verify)
 
bool sslVerifyPeer () const
 
EngineSettingssslCaFile (const std::string &value)
 
const std::string & sslCaFile () const
 
EngineSettingsserviceThreadAffinity (const OnixS::Threading::CpuIndexes &cpuIndexes)
 
EngineSettingsserviceThreadAffinity (const OnixS::Threading::CpuIndex cpuIndex)
 
const OnixS::Threading::CpuIndexesserviceThreadAffinity ()
 
int serviceThreadPriority () const
 
EngineSettingsserviceThreadPriority (int priority)
 
int serviceThreadPolicy () const
 
EngineSettingsserviceThreadPolicy (int policy)
 
EngineSettingstcpNoDelayOption (bool value)
 
bool tcpNoDelayOption () const
 
EngineSettingsreceiveSpinningTimeout (int value)
 
int receiveSpinningTimeout () const
 
EngineSettingssendSpinningTimeout (int value)
 
int sendSpinningTimeout () const
 
EngineSettingsmessageGrouping (unsigned value)
 
unsigned messageGrouping () const
 
unsigned long long fileBasedStorageSegmentSize () const
 
EngineSettingsfileBasedStorageSegmentSize (unsigned long long value)
 
unsigned asyncFileBasedStorageQueueMaxSize () const
 
EngineSettingsasyncFileBasedStorageQueueMaxSize (unsigned value)
 
EngineSettingsasyncFileBasedStorageThreadAffinity (const OnixS::Threading::CpuIndexes &cpuIndexes)
 
EngineSettingsasyncFileBasedStorageThreadAffinity (const OnixS::Threading::CpuIndex cpuIndex)
 
const OnixS::Threading::CpuIndexesasyncFileBasedStorageThreadAffinity ()
 
bool ignoreFileBasedStorageIntegrityErrors () const
 
EngineSettingsignoreFileBasedStorageIntegrityErrors (bool value)
 
bool specifyApplVerIdField () const
 
EngineSettingsspecifyApplVerIdField (bool value)
 
bool specifyLastMsgSeqNumProcessed () const
 
EngineSettingsspecifyLastMsgSeqNumProcessed (bool value)
 
bool reportNewMessagesWhileWaitingForMissedMessages () const
 
EngineSettingsreportNewMessagesWhileWaitingForMissedMessages (bool value)
 
int expectedIncomingMessageSize () const
 
EngineSettingsexpectedIncomingMessageSize (int value)
 
EngineSettingsscrambleLogonFields (const Session::ScrambledFields &fields)
 
Session::ScrambledFields scrambleLogonFields () const
 
EngineSettingssendQueueMaxSize (size_t size)
 
size_t sendQueueMaxSize () const
 
bool validateUnknownMessages () const
 
EngineSettingsvalidateUnknownMessages (bool)
 
bool validateUnknownFields () const
 
EngineSettingsvalidateUnknownFields (bool)
 
bool validateRequiredFields () const
 
EngineSettingsvalidateRequiredFields (bool)
 
bool validateFieldValues () const
 
EngineSettingsvalidateFieldValues (bool)
 
bool validateEmptyFieldValues () const
 
EngineSettingsvalidateEmptyFieldValues (bool)
 
bool validateRepeatingGroupEntryCount () const
 
EngineSettingsvalidateRepeatingGroupEntryCount (bool)
 
bool validateRepeatingGroupLeadingTag () const
 
EngineSettingsvalidateRepeatingGroupLeadingTag (bool)
 
bool validateDuplicatedField () const
 
EngineSettingsvalidateDuplicatedField (bool)
 
bool validateChecksum () const
 
EngineSettingsvalidateChecksum (bool)
 

Static Public Attributes

static const int UseDefaultReceiveBufferSize
 
static const int UseDefaultSendBufferSize
 

Friends

class Engine
 

Detailed Description

Definition at line 45 of file EngineSettings.h.

Constructor & Destructor Documentation

Constructor.

EngineSettings ( const std::string &  configuration)
explicit

Constructor to create the EngineSettings from a Configuration string.

Copy constructor.

Destructor.

Member Function Documentation

unsigned asyncFileBasedStorageQueueMaxSize ( ) const

Gets the log queue maximum size of the asynchronous session storage.

EngineSettings& asyncFileBasedStorageQueueMaxSize ( unsigned  value)

Sets the log queue maximum size of the asynchronous session storage.

EngineSettings& asyncFileBasedStorageThreadAffinity ( const OnixS::Threading::CpuIndexes cpuIndexes)

Sets the CPU affinity of the asynchronous session storage threads.

EngineSettings& asyncFileBasedStorageThreadAffinity ( const OnixS::Threading::CpuIndex  cpuIndex)

Sets the CPU affinity of the asynchronous session storage threads.

const OnixS::Threading::CpuIndexes& asyncFileBasedStorageThreadAffinity ( )

Returns the CPU affinity of the asynchronous session storage threads.

EngineSettings& createEngineLogFile ( bool  value)

Option to create the FIX Engine log file.

bool createEngineLogFile ( ) const

Option to create the FIX Engine log file.

EngineSettings& dialectString ( const std::string &  value)

Specifies the plain text string with description of FIX dialect.

const std::string& dialectString ( ) const

Returns The string contains the plain text string with the description of the FIX dialect.

EngineSettings& dictionaryFile ( const std::string &  value)

Specifies the path(s) to the XML file(s) with the description of the FIX Dictionary(s).

Note
More than one file could be specified. Symbol '|' is used as the file name delimiter.
const std::string& dictionaryFile ( ) const

Returns the path to the XML file with the description of the FIX Dictionary(s).

int expectedIncomingMessageSize ( ) const

Gets the expected incoming FIX message size.

The value represents an average FIX message size that is expected to be received by the session during the lifetime. It is used as a hint for the optimization of the deserialization of large FIX messages with a lot of repeating groups.

Note
The large value of the setting can increase the memory consumption by the incoming Message object, so try to increase the value only in case of a latency degradation of the large incoming FIX messages deserialization.
EngineSettings& expectedIncomingMessageSize ( int  value)

Sets the expected incoming FIX message size.

unsigned long long fileBasedStorageSegmentSize ( ) const

Gets segment size for file based session storage.

EngineSettings& fileBasedStorageSegmentSize ( unsigned long long  value)

Sets segment size for file based session storage.

Parameters
valueMaximum size of single segment (single file) of the storage, in bytes.
bool ignoreFileBasedStorageIntegrityErrors ( ) const

Gets mode of file based storage integrity errors checking. Valuable only when value of fileBasedStorageSegmentSize != 0.

EngineSettings& ignoreFileBasedStorageIntegrityErrors ( bool  value)

Sets mode of file based storage integrity errors checking.

Valuable only when value of fileBasedStorageSegmentSize != 0.

Parameters
valueMode of checking: true - ignore errors and create new storage, false - throw exception.
unsigned licenseAlertingDaysBeforeExpiration ( )

Returns the number of days to alert before the license expiration.

EngineSettings& licenseAlertingDaysBeforeExpiration ( unsigned  value)

Sets the number of days to alert before the license expiration.

If the amount of remaining license days is less or equal to this number then the warning will be reported to the FIX Engine's log and IEngineListener::onWarning callback will be invoked. The verification is performed during the following events: FIX Engine initialization, Session::logonAsAcceptor and Session::logonAsInitiator calls.

EngineSettings& licenseFile ( const std::string &  value)

Specifies the path to the license file.

const std::string& licenseFile ( ) const

Returns the path to the license file.

EngineSettings& licenseStore ( const std::string &  value)

Specifies the path to the license directory.

Note
More than one license store could be specified. Symbol '|' is used as the license store delimiter.
const std::string& licenseStore ( ) const

Returns the path to the license directory.

EngineSettings& licenseString ( const std::string &  value)

Specifies the string of license content.

const std::string& licenseString ( ) const

Returns the string of license content.

EngineSettings& listenPort ( int  value)

FIX Engine listens on this port for incoming "plain text" connections.

Note
If '0' then only session-initiators can be created.
If '-1' then the telecommunication level is disabled and only message parsing/assembling can be used.
int listenPort ( ) const

FIX Engine listens on this port for incoming "plain text" connections.

Note
If '0' then only session-initiators can be created.
If '-1' then the telecommunication level is disabled and only message parsing/assembling can be used.
EngineSettings& listenPorts ( const ListenPorts value)

Set listen ports.

const ListenPorts& listenPorts ( ) const

Returns listen ports.

void loadFromConfigFile ( const std::string &  configFile)

Loads Engine settings from a Configuration file.

const LocalNetworkInterfaces& localNetworkInterface ( ) const

FIX Engine listens on these local interfaces for incoming "plain text" connections.

EngineSettings& localNetworkInterface ( const LocalNetworkInterfaces )

Sets local interfaces where engine listen for incoming connections.

Each local interface specification could specify local IP address and port. For instance "localhost" and "192.168.0.1:4501" are valid values. When a local interface specification contains the same port as specified at listenPort settings the listening appears only on the interface and port specified at localInterface setting.

Note
At least single listen port have to be specified to make engine able to use this setting.
EngineSettings& localNetworkInterface ( const LocalNetworkInterface )

Sets local interface where engine listen for incoming connections.

Each local interface specification could specify local IP address and port. For instance "localhost" and "192.168.0.1:4501" are valid values. When a local interface specification contains the same port as specified at listenPort settings the listening appears only on the interface and port specified at localInterface setting.

Note
At least single listen port have to be specified to make engine able to use this setting.
bool localTimeUsage ( ) const

Gets the usage of local time in FIX Engine events and log files.

EngineSettings& localTimeUsage ( bool  value)

Specifies the usage of local time in FIX Engine events and log files.

Parameters
valueIf it is true - local time usage, if it is false - UTC time usage.
bool logBeforeSending ( ) const

Returns 'true' if outbound messages are logged before sending, otherwise - 'false'.

EngineSettings& logBeforeSending ( bool  value)

Option to switch on/off logging of outbound messages before/after sending.

EngineSettings& logDirectory ( const std::string &  value)

Inbound and outbound messages, session's state data and the FIX Engine log file (FixEngineLog.txt) are stored in this directory.

const std::string& logDirectory ( ) const

Inbound and outbound messages, session's state data and the FIX Engine log file (FixEngineLog.txt) are stored in this directory.

const std::string& logFileName ( ) const

Returns the FIX Engine log file name.

EngineSettings& logFileName ( const std::string &  value)

Sets the FIX Engine log file name.

bool logInboundMessages ( ) const

Returns 'true' if inbound messages are logged, otherwise - 'false'.

EngineSettings& logInboundMessages ( bool  value)

Option to log inbound messages.

bool logOutboundMessages ( ) const

Returns 'true' if outbound messages are logged, otherwise - 'false'.

EngineSettings& logOutboundMessages ( bool  value)

Option to log outbound messages.

EngineSettings& messageGrouping ( unsigned  value)

Sets message grouping option Value 0 means default grouping - the messages will be tried to send ASAP and pending messages (if any) will be grouped till reaching of TCP buffer size.

Value 1 means the messages will be sent ASAP and never will be grouped. Value 2 (or greater) means the messages will be sent ASAP and pending messages will be grouped maximum by 2 (or greater).

unsigned messageGrouping ( ) const

Gets message grouping option.

EngineSettings& operator= ( const EngineSettings )

Assignment.

EngineSettings& processDeliverToCompId ( bool  value)

Option to process the DeliverToCompID (tag 128) flag.

bool processDeliverToCompId ( ) const

Option to process the DeliverToCompID (tag 128) flag.

EngineSettings& reasonableTransmissionTime ( int  value)

The reasonable transmission time as % from HeartBtInt value.

When either end of the connection has not received any data for (HeartBtInt * (100 + ReasonableTransmissionTime)/100) seconds, it will transmit a Test Request message.

If there is still no Heartbeat message received after (HeartBtInt * (100 + ReasonableTransmissionTime)/100) seconds then the connection should be considered lost and corrective action be initiated.

See also
If you need to change this option for separate session, please use OnixS::FIX::Session::setReasonableTransmissionTime(int).
int reasonableTransmissionTime ( ) const

The reasonable transmission time as % from HeartBtInt value.

When either end of the connection has not received any data for (HeartBtInt * (100 + ReasonableTransmissionTime)/100) seconds, it will transmit a Test Request message.

If there is still no Heartbeat message received after (HeartBtInt * (100 + ReasonableTransmissionTime)/100) seconds then the connection should be considered lost and corrective action be initiated.

See also
You also can get value of this option for separate session using OnixS::FIX::Session::getReasonableTransmissionTime().
int receiveBufferSize ( ) const

Returns the size of the TCP buffer allocated to the FIX connection for receiving data.

If '-1' then the default operating system value is used.

EngineSettings& receiveBufferSize ( int  value)

Sets the size of the TCP buffer allocated to the FIX connection for receiving data.

If '-1' then the default operating system value is used.

EngineSettings& receiveSpinningTimeout ( int  value)

Sets the non-blocking receive spinning timeout (in microseconds) before the receiving thread enters into the blocking wait mode.

Note
Should not be greater than 1 sec (minimal Heartbeat interval).
int receiveSpinningTimeout ( ) const

Gets the current receive spinning timeout value (in microseconds).

EngineSettings& reconnectAttempts ( int  value)

Sets the number of attempts to restore the FIX connection.

int reconnectAttempts ( ) const

Returns the number of attempts to restore the FIX connection.

EngineSettings& reconnectInterval ( int  value)

Sets the time interval between the attempts to restore FIX connection (in seconds).

int reconnectInterval ( ) const

Returns the time interval between the attempts to restore the FIX connection (in seconds).

bool reportNewMessagesWhileWaitingForMissedMessages ( ) const

When the message gap is detected the "Resend Request" FIX Message is sent and Session state is changed to "AwaitReplyOnResendRequest".

By default in this state the incoming new messages (without the PossDupFlag (tag #43) flag) are ignored because we expect them to be re-sent later again with the PossDupFlag flag.

This property allows to change this behavior and report the new messages anyway.

Note
In this mode messages could be reported out of the original order: e.g. MsgSeqNum could be: 3 (original), 4 (original), 2 (PossDupFlag='Y'), 3 (PossDupFlag='Y'), 4 (PossDupFlag='Y') and some messages could be received two times: first time without PossDupFlag='Y' and second time - with this flag.
EngineSettings& reportNewMessagesWhileWaitingForMissedMessages ( bool  value)

Sets option to report new messages while waiting for missed messages.

EngineSettings& resendingQueueSize ( size_t  value)

Sets the number of sent messages that are available for resending on counterparty's Resend Request <2> message.

size_t resendingQueueSize ( ) const

Returns the number of sent messages that are available for resending on counterparty's Resend Request <2> message.

The zero value means that sent messages are not available for resending. The value cannot be negative.

EngineSettings& resendRequestMaximumRange ( int  value)

Sets the maximum number of messages to be requested in one Resend Request (MsgType=2) message.

int resendRequestMaximumRange ( ) const

Returns the maximum number of messages to be requested in one Resend Request (MsgType=2) message.

EngineSettings& scrambleLogonFields ( const Session::ScrambledFields fields)

Sets option to scramble fields in the Logon(A) message, in the session storage and FIX Engine log, for security reasons.

Session::ScrambledFields scrambleLogonFields ( ) const

Gets scrambled fields in the Logon(A) message.

int sendBufferSize ( ) const

Returns the size of the TCP buffer allocated to the FIX connection for sending data.

If '-1' then the default operating system value is used.

EngineSettings& sendBufferSize ( int  value)

Sets the size of the TCP buffer allocated to the FIX connection for sending data.

If '-1' then the default operating system value is used.

EngineSettings& sendLogoutOnException ( bool  value)

Returns the value of the option to send the Logout message before dropping the telecommunication link in case of Exception during the processing of incoming FIX message.

bool sendLogoutOnException ( ) const

Option to send the Logout message before dropping the telecommunication link in case of Exception during the processing of incoming FIX message.

EngineSettings& sendLogoutOnInvalidLogon ( bool  value)

Returns the value of the option to send the Logout message before dropping the telecommunication link in case of an invalid logon attempt.

bool sendLogoutOnInvalidLogon ( ) const

Option to send the Logout message before dropping the telecommunication link in case of an invalid logon attempt.

EngineSettings& sendQueueMaxSize ( size_t  size)

Sets the send queue maximum size in bytes.

size_t sendQueueMaxSize ( ) const

Gets the send queue maximum size in bytes.

EngineSettings& sendSpinningTimeout ( int  value)

Sets the send spinning timeout (in microseconds) of the Session::send(..) 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).

Note
Should not be greater than 1 sec (minimal Heartbeat interval).
int sendSpinningTimeout ( ) const

Gets the current send spinning timeout value (in microseconds).

EngineSettings& serviceThreadAffinity ( const OnixS::Threading::CpuIndexes cpuIndexes)

Sets the CPU affinity of the Engine service threads.

EngineSettings& serviceThreadAffinity ( const OnixS::Threading::CpuIndex  cpuIndex)

Sets the CPU affinity of the Engine service threads.

const OnixS::Threading::CpuIndexes& serviceThreadAffinity ( )

Returns the CPU affinity of the Engine service threads.

int serviceThreadPolicy ( ) const

Returns the policy of the Engine service threads.

EngineSettings& serviceThreadPolicy ( int  policy)

Sets the policy of the Engine service threads.

int serviceThreadPriority ( ) const

Returns the priority of the Engine service threads.

EngineSettings& serviceThreadPriority ( int  priority)

Sets the priority of the Engine service threads.

bool specifyApplVerIdField ( ) const

Gets option to specify ApplVerID(1128) tag in all application FIX messages when a FIX protocol version FIX 5.0 and above is used.

EngineSettings& specifyApplVerIdField ( bool  value)

Sets option to specify ApplVerID(1128) tag in all application FIX messages when a FIX protocol version FIX 5.0 and above is used.

bool specifyLastMsgSeqNumProcessed ( ) const

Gets option to specify the LastMsgSeqNumProcessed (tag=369) field on every message sent. Useful for detecting a backlog with a counterparty.

EngineSettings& specifyLastMsgSeqNumProcessed ( bool  value)

Sets option to specify the LastMsgSeqNumProcessed (tag=369) field on every message sent. Useful for detecting a backlog with a counterparty.

EngineSettings& sslCaFile ( const std::string &  value)

Sets the path to the trusted certification authority certificate file in (Privacy Enhanced Mail) Base64 encoded (.pem) format.

const std::string& sslCaFile ( ) const

Returns the path to trusted certification authority certificate file in (Privacy Enhanced Mail) Base64 encoded (.pem) format.

EngineSettings& sslCertificateFile ( const std::string &  value)

Sets the path to the SSL certificate file in (Privacy Enhanced Mail) Base64 encoded (.pem) format.

const std::string& sslCertificateFile ( ) const

Returns the path to the SSL certificate file in (Privacy Enhanced Mail) Base64 encoded (.pem) format.

EngineSettings& sslListenPort ( int  value)

FIX Engine listens on this port for incoming SSL connections.

Note
If '0' then only session-initiators can be created.
If '-1' then the telecommunication level is disabled and only message parsing/assembling can be used.
int sslListenPort ( ) const

FIX Engine listens on this port for incoming SSL connections.

Note
If '0' then only session-initiators can be created.
If '-1' then the telecommunication level is disabled and only message parsing/assembling can be used.
EngineSettings& sslListenPorts ( const ListenPorts value)

Sets SSL listen ports.

const ListenPorts& sslListenPorts ( ) const

Returns SSL listen ports.

const LocalNetworkInterfaces& sslLocalInterface ( ) const

FIX Engine listens on these local interfaces for incoming SSL connections.

EngineSettings& sslLocalInterface ( const LocalNetworkInterfaces )

Sets local interfaces where engine listen for incoming SSL connections.

Note
At least single SSL-listen port have to be specified to make engine able to use this setting.
EngineSettings& sslPrivateKeyFile ( const std::string &  value)

Sets the path to the SSL private key file in (Privacy Enhanced Mail) Base64 encoded (.pem) format.

const std::string& sslPrivateKeyFile ( ) const

Returns the path to the SSL private key file in (Privacy Enhanced Mail) Base64 encoded (.pem) format.

EngineSettings& sslPrivateKeyPassword ( const Cryptography::SecureString value)

Set the password to load private keys that are protected by a password.

Cryptography::SecureString sslPrivateKeyPassword ( ) const

Returns the password to load private keys that are protected by a password.

EngineSettings& sslVerifyPeer ( bool  verify)

Set option to request client certificates and perform the certificate verification.

bool sslVerifyPeer ( ) const

Returns option to request client certificates and perform the certificate verification.

EngineSettings& tcpNoDelayOption ( bool  value)

Sets option to improve latency at the expense of message throughput (TCP_NODELAY).

bool tcpNoDelayOption ( ) const

Gets option to improve latency at the expense of message throughput (TCP_NODELAY).

ThreadingModel::Enum threadingModel ( ) const

Returns the default mode for outbound and incoming connections.

EngineSettings& threadingModel ( ThreadingModel::Enum  value)

Sets the default mode for outbound and incoming connections.

EngineSettings& threadPoolSize ( int  size)

Sets thread pool size.

int threadPoolSize ( ) const

Returns thread pool size.

bool useSpinLock ( ) const

Returns the default mode for using a spinlock.

EngineSettings& useSpinLock ( bool  value)

Returns the default mode for using a spinlock.

bool validateChecksum ( ) const

Get option to validate the checksum of incoming messages.

EngineSettings& validateChecksum ( bool  )

Set option to validate the checksum of incoming messages.

bool validateDuplicatedField ( ) const

Get option to validate the duplicated field.

EngineSettings& validateDuplicatedField ( bool  )

Set option to validate the duplicated field.

bool validateEmptyFieldValues ( ) const

Get option to validate the empty field values of FIX messages in accordance with the FIX protocol or its FIX Dictionary.

EngineSettings& validateEmptyFieldValues ( bool  )

Set option to validate the empty field values of FIX messages in accordance with the FIX protocol or its FIX Dictionary.

bool validateFieldValues ( ) const

Get option to validate the field values of FIX messages in accordance with the FIX protocol or its FIX Dictionary.

EngineSettings& validateFieldValues ( bool  )

Set option to validate the field values of FIX messages in accordance with the FIX protocol or its FIX Dictionary.

bool validateRepeatingGroupEntryCount ( ) const

Get option to validate the repeating group size of FIX messages in accordance with the FIX protocol or its FIX Dictionary.

EngineSettings& validateRepeatingGroupEntryCount ( bool  )

Set option to validate the repeating group size of FIX messages in accordance with the FIX protocol or its FIX Dictionary.

bool validateRepeatingGroupLeadingTag ( ) const

Get option to validate the repeating group leading tag of FIX messages in accordance with the FIX protocol or its FIX Dictionary.

EngineSettings& validateRepeatingGroupLeadingTag ( bool  )

Set option to validate the repeating group leading tag of FIX messages in accordance with the FIX protocol or its FIX Dictionary.

bool validateRequiredFields ( ) const

Get option to validate the presence of required fields in inbound and outbound messages.

EngineSettings& validateRequiredFields ( bool  )

Set option to validate the presence of required fields in inbound and outbound messages.

bool validateUnknownFields ( ) const

Get option to validate the presence of unknown fields (fields that do not belong to the message in accordance with the FIX protocol or its FIX Dictionary.

EngineSettings& validateUnknownFields ( bool  )

Set option to validate the presence of unknown fields (fields that do not belong to the message in accordance with the FIX protocol or its FIX Dictionary.

bool validateUnknownMessages ( ) const

Get option to validate the presence of unknown FIX messages (messages that do not belong to the message in accordance with the FIX protocol or its FIX Dictionary).

EngineSettings& validateUnknownMessages ( bool  )

Set option to validate the presence of unknown FIX messages (messages that do not belong to the message in accordance with the FIX protocol or its FIX Dictionary).

Friends And Related Function Documentation

friend class Engine
friend

Definition at line 535 of file EngineSettings.h.

Member Data Documentation

const int UseDefaultReceiveBufferSize
static

Specifies the usage of the operating system default RecvBuffer size.

Definition at line 266 of file EngineSettings.h.

const int UseDefaultSendBufferSize
static

Specifies the usage of the operating system default SendBuffer size.

Definition at line 277 of file EngineSettings.h.


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