OnixS Eurex ETI Handler C++ library  9.10.1
API documentation
HandlerSettings Struct Reference

#include <OnixS/Eurex/Trading/HandlerSettings.h>

Public Member Functions

 HandlerSettings ()
 
 HandlerSettings (const HandlerSettings &)
 
std::string toString () const
 

Public Attributes

std::string licenseDirectory
 
std::string logDirectory
 
std::string logFileNamePrefix
 
LogSettings::Enum logSettings
 
LogLevel::Enum logLevel
 
int receivingTimeoutMs
 
int sendingTimeoutMs
 
CpuIndexes receivingThreadAffinity
 
CpuIndexes sendingThreadAffinity
 
CpuIndexes auditTrailThreadAffinity
 
ConnectionRetries connectionRetries
 
std::string auditTrailDirectory
 
std::string auditTrailFile
 
std::string auditTrailFileNamePrefix
 
AuditTrailMode::Enum auditTrailMode
 
size_t throttleMessageMargin
 
bool treatReceiverInactivityAsWarning
 
bool scramblePassword
 
unsigned reasonableTransmissionTime
 

Detailed Description

Definition at line 82 of file HandlerSettings.h.

Constructor & Destructor Documentation

Constructor.

Copy constructor.

Member Function Documentation

std::string toString ( ) const

Returns the string representation.

Member Data Documentation

std::string auditTrailDirectory

Audit Trail files are stored in this directory.

Note
The default value is empty string.

Definition at line 142 of file HandlerSettings.h.

std::string auditTrailFile

Definition at line 146 of file HandlerSettings.h.

std::string auditTrailFileNamePrefix

Template of Audit Trail file name without extension.

Creates Audit Trail file that contains all messages that Handler sent or received (in the chronological order).

Note
The default value is empty string (means no audit trail files required).

Definition at line 153 of file HandlerSettings.h.

AuditTrailMode::Enum auditTrailMode

Audit Trail mode.

Note
By default it's Text.

Definition at line 158 of file HandlerSettings.h.

CpuIndexes auditTrailThreadAffinity

CPU affinity of the audit-trail thread.

Definition at line 132 of file HandlerSettings.h.

ConnectionRetries connectionRetries

Connection retries configuration settings.

See also
ConnectionRetries.

Definition at line 137 of file HandlerSettings.h.

std::string licenseDirectory

Path to the license directory.

Note
The default value is empty string (means current directory).

Definition at line 93 of file HandlerSettings.h.

std::string logDirectory

Log files are stored in this directory.

Note
The default value is "logs".

Definition at line 98 of file HandlerSettings.h.

std::string logFileNamePrefix

Template of log file name without extension.

Note
The default value is "EurexEtiTradingHandlerCpp".

Definition at line 103 of file HandlerSettings.h.

LogLevel::Enum logLevel

Log verbosity.

Note
The default value is LogLevel::Info.

Definition at line 113 of file HandlerSettings.h.

LogSettings::Enum logSettings

Combine LogSettings enum values to configure the logger.

Note
The default value is LogSettings::Default.

Definition at line 108 of file HandlerSettings.h.

unsigned reasonableTransmissionTime

Reasonable transmission time. This option controls the percentage from the heartbeat interval.

Note
By default it's 20.

Definition at line 200 of file HandlerSettings.h.

CpuIndexes receivingThreadAffinity

CPU affinity of the receiving thread.

Definition at line 126 of file HandlerSettings.h.

int receivingTimeoutMs

Receiving timeout in milliseconds.

Note
The default value is 2 seconds (2000 ms).

Definition at line 118 of file HandlerSettings.h.

bool scramblePassword

This flag is used to control the Handler's behavior whether to scramble passwords in the log and audit files.

Note
By default it's false.

Definition at line 194 of file HandlerSettings.h.

CpuIndexes sendingThreadAffinity

CPU affinity of the receiving thread.

Definition at line 129 of file HandlerSettings.h.

int sendingTimeoutMs

Sending timeout in milliseconds.

Note
The default value is 2 seconds (2000 ms).

Definition at line 123 of file HandlerSettings.h.

size_t throttleMessageMargin

Throttle message margin. Transaction limit will be reduced by this value.

For example, if Eurex notify that transaction limit is 20 messages and this Handler's setting isn't changed (by default value is 3), then transaction limit for Handler is 20 - 3 = 17 messages.

Note
By default it's 3.

Definition at line 167 of file HandlerSettings.h.

bool treatReceiverInactivityAsWarning

This flag is used to control the Handler's behavior when a connection is not able to receive data from a network.

Absence of data could be caused by network or exchange issues. If server stopped sending data due to internal issues but underlying TCP connection is not broken, it could make sense to switch to manual control and use this option.

By default, the Handler will call error callback and restart the connection. If this flag is set to true, only warning callback will be called and the Handler continue to work.

Note
By default it's false.

Definition at line 187 of file HandlerSettings.h.


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