OnixS C++ CBOE CFE Binary Order Entry (BOE) Handler 1.12.0
API documentation
Loading...
Searching...
No Matches
HandlerSettings Struct Reference

Public Member Functions

 HandlerSettings ()

Public Attributes

std::string licenseDirectory
std::string logDirectory
std::string logFileNamePrefix
LogSettings::Enum logSettings
LogLevel::Enum logLevel
int receiveTimeoutMs
int sendTimeoutMs
CpuIndexes receivingThreadAffinity
CpuIndexes sendingThreadAffinity
ConnectionRetries connectionRetries
std::string auditTrailDirectory
std::string auditTrailFile
CpuIndexes auditTrailThreadAffinity
size_t auditTrailFileMaxSize
unsigned receiveSpinningTimeout
unsigned sendSpinningTimeout

Detailed Description

Handler settings.

Definition at line 78 of file HandlerSettings.h.

Constructor & Destructor Documentation

◆ HandlerSettings()

HandlerSettings ( )
inline

Initialize default instance.

Definition at line 82 of file HandlerSettings.h.

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

◆ auditTrailFile

std::string auditTrailFile

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

◆ auditTrailFileMaxSize

size_t auditTrailFileMaxSize

Max size for audit trail file in megabytes, another file will be created if the size is exceeded.

Note
The default value is 1024 Mb.

Definition at line 161 of file HandlerSettings.h.

◆ auditTrailThreadAffinity

CpuIndexes auditTrailThreadAffinity

CPU affinity of the audit trail thread.

Definition at line 156 of file HandlerSettings.h.

◆ connectionRetries

ConnectionRetries connectionRetries

Connection retries configuration settings.

See also
ConnectionRetries.

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

◆ logDirectory

std::string logDirectory

Log files are stored in this directory.

Note
The default value is "logs".

Definition at line 102 of file HandlerSettings.h.

◆ logFileNamePrefix

std::string logFileNamePrefix

Template of log file name without extension.

Note
The default value is "CboeCfeBoeHandlerCpp".

Definition at line 107 of file HandlerSettings.h.

◆ logLevel

LogLevel::Enum logLevel

Log verbosity.

Note
The default value is LogLevel::Info.

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

◆ receiveSpinningTimeout

unsigned receiveSpinningTimeout

Sets the receive spinning timeout (microseconds).

Definition at line 164 of file HandlerSettings.h.

◆ receiveTimeoutMs

int receiveTimeoutMs

Receive timeout in milliseconds.

Note
The default value is 1 seconds (1000 ms).

Definition at line 122 of file HandlerSettings.h.

◆ receivingThreadAffinity

CpuIndexes receivingThreadAffinity

CPU affinity of the receiving thread.

Definition at line 131 of file HandlerSettings.h.

◆ sendingThreadAffinity

CpuIndexes sendingThreadAffinity

CPU affinity of the sending thread.

Definition at line 135 of file HandlerSettings.h.

◆ sendSpinningTimeout

unsigned sendSpinningTimeout

Sets the send spinning timeout (microseconds).

Definition at line 167 of file HandlerSettings.h.

◆ sendTimeoutMs

int sendTimeoutMs

Send timeout in milliseconds.

Note
The default value is 1 seconds (1000 ms).

Definition at line 127 of file HandlerSettings.h.