HandlerSettings Struct Reference

Public Member Functions
	HandlerSettings ()
	HandlerSettings (const HandlerSettings &)
std::string	toString () const

Public Attributes
std::string	licenseString
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
bool	sslEnabled

Detailed Description

Definition at line 96 of file HandlerSettings.h.

Constructor & Destructor Documentation

HandlerSettings() [1/2]

HandlerSettings

(

)

Constructor.

HandlerSettings() [2/2]

HandlerSettings

(

const HandlerSettings &

)

Copy constructor.

Member Function Documentation

toString()

std::string toString

(

)

const

Returns the string representation.

Member Data Documentation

auditTrailDirectory

std::string auditTrailDirectory

Audit Trail files are stored in this directory.

Note

The default value is empty string.

Definition at line 164 of file HandlerSettings.h.

auditTrailFile

std::string auditTrailFile

Deprecated

Please use auditTrailFileNamePrefix instead of this deprecated field.

Definition at line 169 of file HandlerSettings.h.

auditTrailFileNamePrefix

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 177 of file HandlerSettings.h.

auditTrailMode

AuditTrailMode::Enum auditTrailMode

Audit Trail mode.

Note

By default it's Text.

Definition at line 182 of file HandlerSettings.h.

auditTrailThreadAffinity

CpuIndexes auditTrailThreadAffinity

CPU affinity of the audit-trail thread.

Definition at line 154 of file HandlerSettings.h.

connectionRetries

ConnectionRetries connectionRetries

Connection retries configuration settings.

See also

ConnectionRetries.

Definition at line 159 of file HandlerSettings.h.

licenseDirectory

std::string licenseDirectory

Path to the license directory.

Note

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

Definition at line 115 of file HandlerSettings.h.

licenseString

std::string licenseString

Content of the license file as a string.

Note

Default value is empty string.

The Handler checks this license first.

Definition at line 110 of file HandlerSettings.h.

logDirectory

std::string logDirectory

Log files are stored in this directory.

Note

The default value is "logs".

Definition at line 120 of file HandlerSettings.h.

logFileNamePrefix

std::string logFileNamePrefix

Template of log file name without extension.

Note

The default value is "EurexEtiTradingHandlerCpp".

Definition at line 125 of file HandlerSettings.h.

logLevel

LogLevel::Enum logLevel

Log verbosity.

Note

The default value is LogLevel::Info.

Definition at line 135 of file HandlerSettings.h.

logSettings

LogSettings::Enum logSettings

Combine LogSettings enum values to configure the logger.

Note

The default value is LogSettings::Default.

Definition at line 130 of file HandlerSettings.h.

reasonableTransmissionTime

unsigned reasonableTransmissionTime

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

Note

By default it's 20.

Definition at line 224 of file HandlerSettings.h.

receivingThreadAffinity

CpuIndexes receivingThreadAffinity

CPU affinity of the receiving thread.

Definition at line 148 of file HandlerSettings.h.

receivingTimeoutMs

int receivingTimeoutMs

Receiving timeout in milliseconds.

Note

The default value is 2 seconds (2000 ms).

Definition at line 140 of file HandlerSettings.h.

scramblePassword

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 218 of file HandlerSettings.h.

sendingThreadAffinity

CpuIndexes sendingThreadAffinity

CPU affinity of the receiving thread.

Definition at line 151 of file HandlerSettings.h.

sendingTimeoutMs

int sendingTimeoutMs

Sending timeout in milliseconds.

Note

The default value is 2 seconds (2000 ms).

Definition at line 145 of file HandlerSettings.h.

sslEnabled

bool sslEnabled

Is SSL enabled for the connection to exchange?

Note

By default it's false.

Definition at line 229 of file HandlerSettings.h.

throttleMessageMargin

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 191 of file HandlerSettings.h.

treatReceiverInactivityAsWarning

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 211 of file HandlerSettings.h.