HandlerSettings Struct Reference

#include <OnixS/Senaf/MarketData/HandlerSettings.h>

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

Public Attributes
std::string	licenseString
std::string	licenseDirectory
std::string	logDirectory
std::string	logFileNamePrefix
LogLevel	logLevel
AdvancedLogOptionSet	advancedLogOptions
std::string	networkInterface
time_t	heartbeatInterval
ThreadAffinity	processingThreadAffinity
std::string	applicationName
std::string	applicationPassword
unsigned short	applicationVersion
ConnectionRetries	connectionRetries
CpuIndexes	receivingThreadAffinity
CpuIndexes	sendingThreadAffinity
LogList	logs
LogReplayInputStream *	inputStream
float	logPlayerSpeedMultiplier
unsigned	logPlayerSpeedAuxDelay
std::string	auditTrailDirectory
std::string	auditTrailFileNamePrefix
CpuIndexes	auditTrailThreadAffinity
std::string	marketImageDirectory
std::string	marketImageFileNamePrefix

Detailed Description

Definition at line 107 of file HandlerSettings.h.

Constructor & Destructor Documentation

HandlerSettings

(

)

Initializes instance with default values for control parameters.

Member Function Documentation

std::string toString

(

)

const

Returns string representation.

Member Data Documentation

AdvancedLogOptionSet advancedLogOptions

Additional options to control which data is to be logged. Ignored if logging is disabled.

Note

The default value is AdvancedLogOptions::Default.

Definition at line 152 of file HandlerSettings.h.

std::string applicationName

Application Name.

Definition at line 189 of file HandlerSettings.h.

std::string applicationPassword

Application Password.

Definition at line 194 of file HandlerSettings.h.

unsigned short applicationVersion

Application Version.

Definition at line 199 of file HandlerSettings.h.

std::string auditTrailDirectory

Audit Trail files are stored in this directory.

Note

The default value is empty string.

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

CpuIndexes auditTrailThreadAffinity

CPU affinity of the audit-trail thread.

Definition at line 259 of file HandlerSettings.h.

ConnectionRetries connectionRetries

Connection retries configuration settings.

Definition at line 204 of file HandlerSettings.h.

time_t heartbeatInterval

Specifies maximal time interval in seconds between two network packets. If no data is received during specified time frame, warning is reported.

Note

The default value is 3.

Definition at line 174 of file HandlerSettings.h.

LogReplayInputStream* inputStream

User defined input stream for log replay logs will be ignored.

Definition at line 224 of file HandlerSettings.h.

std::string licenseDirectory

Path to the license directory.

Note

Default value is "./" (the current directory).

A home directory also used to search a license.

Definition at line 123 of file HandlerSettings.h.

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

std::string logDirectory

Log files are stored in this directory.

Note

Default value is "./" (the current directory).

Definition at line 130 of file HandlerSettings.h.

std::string logFileNamePrefix

Template of log file name without extension.

Note

Default value is "SenafMarketDataHandlerCpp".

Definition at line 137 of file HandlerSettings.h.

LogLevel logLevel

Log verbosity.

Note

Default value is LogLevels::Info.

Definition at line 144 of file HandlerSettings.h.

unsigned logPlayerSpeedAuxDelay

Log player speed auxiliary delay.

This is an \( k \) in the formula \( mT+k \) to calculate delays between packets, where \( T \) is original delay. Default value is 0.

Definition at line 242 of file HandlerSettings.h.

float logPlayerSpeedMultiplier

Log player speed multiplier.

This is an \( m \) in the formula \( mT+k \) to calculate delays between packets, where \( T \) is original delay. Values less than 1 means reduced speed, greater than 1 means increased speed. Default value is 1.0 which means a normal speed.

Definition at line 234 of file HandlerSettings.h.

LogList logs

List of logs to be replated.

Attention

Must be stored in 'oldest to recent' order.

Definition at line 221 of file HandlerSettings.h.

std::string marketImageDirectory

Market Image (Debug) files will be stored in this directory.

Note

The default value is "dump".

Definition at line 264 of file HandlerSettings.h.

std::string marketImageFileNamePrefix

Template of Market Image (Debug) file name without extension.

Creates Market Image file. See 5.6. Debugging and Testing Support for more details.

Note

The default value is "File".

Definition at line 272 of file HandlerSettings.h.

std::string networkInterface

Specifies one or more network interfaces to use while joining the multicast group; use semi-colon delimited list if more than one.

Note

On Linux the network interface is specified by its name, on Windows - by IP address.

If the value is empty or absent then the default networking interface is used.

Definition at line 165 of file HandlerSettings.h.

ThreadAffinity processingThreadAffinity

Defines set of CPUs by their indices (starting from zero) allowed for thread used by the Handler while processing market data to be executed on.

Note

By default set is empty thus allowing threads to be executed on any CPU available in the system.

Definition at line 184 of file HandlerSettings.h.

CpuIndexes receivingThreadAffinity

CPU affinity of the receiving thread.

Definition at line 209 of file HandlerSettings.h.

CpuIndexes sendingThreadAffinity

CPU affinity of the receiving thread.

Definition at line 214 of file HandlerSettings.h.

---

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

• include/OnixS/Senaf/MarketData/HandlerSettings.h