OnixS C++ MTS Bond Vision SDP Handler  1.2.0
API documentation
HandlerSettings Struct Reference

#include <OnixS/MTS/BondVision/SDP/HandlerSettings.h>

Public Member Functions

 HandlerSettings ()
 
std::string toString () const
 

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
 
int auditTrailFileMaxSize
 

Detailed Description

Handler settings.

Definition at line 66 of file HandlerSettings.h.

Constructor & Destructor Documentation

Initialize default instance.

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

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

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

CpuIndexes auditTrailThreadAffinity

CPU affinity of the audit trail thread.

Definition at line 134 of file HandlerSettings.h.

ConnectionRetries connectionRetries

Connection retries configuration settings.

See also
ConnectionRetries.

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

std::string logDirectory

Log files are stored in this directory.

Note
The default value is "logs".

Definition at line 80 of file HandlerSettings.h.

std::string logFileNamePrefix

Template of log file name without extension.

Note
The default value is "MtsCashSdpHandlerCpp".

Definition at line 85 of file HandlerSettings.h.

LogLevel::Enum logLevel

Log verbosity.

Note
The default value is LogLevel::Info.

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

int receiveTimeoutMs

Receive timeout in milliseconds.

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

Definition at line 100 of file HandlerSettings.h.

CpuIndexes receivingThreadAffinity

CPU affinity of the receiving thread.

Definition at line 109 of file HandlerSettings.h.

CpuIndexes sendingThreadAffinity

CPU affinity of the sending thread.

Definition at line 113 of file HandlerSettings.h.

int sendTimeoutMs

Send timeout in milliseconds.

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

Definition at line 105 of file HandlerSettings.h.


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