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
ConnectionRetries	connectionRetries
bool	treatReceiverInactivityAsWarning
bool	scramblePassword
unsigned	reasonableTransmissionTime
bool	sslEnabled

Detailed Description

Definition at line 67 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

connectionRetries

ConnectionRetries connectionRetries

Connection retries configuration settings.

See also

ConnectionRetries.

Definition at line 127 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 86 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 81 of file HandlerSettings.h.

logDirectory

std::string logDirectory

Log files are stored in this directory.

Note

The default value is "logs".

Definition at line 91 of file HandlerSettings.h.

logFileNamePrefix

std::string logFileNamePrefix

Template of log file name without extension.

Note

The default value is "EurexEdciHandlerCpp".

Definition at line 96 of file HandlerSettings.h.

logLevel

LogLevel::Enum logLevel

Log verbosity.

Note

The default value is LogLevel::Info.

Definition at line 106 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 101 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 160 of file HandlerSettings.h.

receivingThreadAffinity

CpuIndexes receivingThreadAffinity

CPU affinity of the receiving thread.

Definition at line 119 of file HandlerSettings.h.

receivingTimeoutMs

int receivingTimeoutMs

Receiving timeout in milliseconds.

Note

The default value is 2 seconds (2000 ms).

Definition at line 111 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 154 of file HandlerSettings.h.

sendingThreadAffinity

CpuIndexes sendingThreadAffinity

CPU affinity of the receiving thread.

Definition at line 122 of file HandlerSettings.h.

sendingTimeoutMs

int sendingTimeoutMs

Sending timeout in milliseconds.

Note

The default value is 2 seconds (2000 ms).

Definition at line 116 of file HandlerSettings.h.

sslEnabled

bool sslEnabled

Controls whether the connection to the exchange is established over TLS.

EDCI gateways in the Production and Simulation environments require a TLS-secured TCP/IP connection, so this flag should normally be left at its default.

Note

By default it's true.

Definition at line 171 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 the server stopped sending data due to internal issues but the underlying TCP connection is not broken, it could make sense to keep the connection alive and let the user code decide how to react.

When set to true, the Handler invokes the warning callback and continues to work on receiver inactivity. When set to false, the Handler invokes the error callback and restarts the connection instead.

Note

By default it's true.

Definition at line 147 of file HandlerSettings.h.