OnixS C++ Tullett Prebon SURF Handler  1.6.1
API documentation
HandlerSettings Struct Reference

#include <OnixS/SURF/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
 
LogSettings::Enum logSettings
 
LogLevel::Enum logLevel
 
std::string localNetworkInterface
 
int receiveTimeoutInMilliseconds
 
unsigned receiveSpinningTimeoutInMicroseconds
 
int cpuIndex
 
ConnectionRetries connectionRetries
 

Detailed Description

Definition at line 61 of file HandlerSettings.h.

Constructor & Destructor Documentation

Constructor.

Member Function Documentation

std::string toString ( ) const

Returns the string representation.

Member Data Documentation

ConnectionRetries connectionRetries

Connection retries configuration settings.

See also
ConnectionRetries.

Definition at line 112 of file HandlerSettings.h.

int cpuIndex

Sets the processor affinity mask for the TCP receiving thread.

Default value is -1 (undefined).

Definition at line 107 of file HandlerSettings.h.

std::string licenseDirectory

Path to the license directory.

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

std::string localNetworkInterface

Sets the local network interface from which you intend to receive data.

Definition at line 90 of file HandlerSettings.h.

std::string logDirectory

Log files are stored in this directory.

Definition at line 76 of file HandlerSettings.h.

std::string logFileNamePrefix

Template of log file name without extension.

Definition at line 79 of file HandlerSettings.h.

LogLevel::Enum logLevel

Log verbosity.

Note
The default value is LogLevel::Info

Definition at line 87 of file HandlerSettings.h.

LogSettings::Enum logSettings

Combine LogSettings enum values to configure the logger.

Definition at line 82 of file HandlerSettings.h.

unsigned receiveSpinningTimeoutInMicroseconds

Non-blocking receive spinning timeout (in microseconds) before the receiving thread enters into the blocking wait mode.

Default value is 0 (turned off).

Definition at line 102 of file HandlerSettings.h.

int receiveTimeoutInMilliseconds

Timeout value in milliseconds. If 0 then the receiving blocks until some data is received.

Note
The default value is 120000 milliseconds (120 seconds) because a heartbeat record will be transmitted every 2 minutes.

Definition at line 96 of file HandlerSettings.h.


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