OnixS C++ Tradeweb Approved Publication Arrangement (APA) Handler  1.2.2.18
API documentation
Public Member Functions | Public Attributes | List of all members
HandlerSettings Struct Reference

#include <HandlerSettings.h>

Collaboration diagram for HandlerSettings:
Collaboration graph
[legend]

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
 
LogFilePermission::Enum logFilePermissions
 
std::string networkInterface
 
std::string networkInterfaceA
 
std::string networkInterfaceB
 
UInt32 heartbeatInterval
 
UInt32 outOfOrderPacketMaxInterval
 
UInt32 lostPacketWaitTime
 
bool useFeedA
 
bool useFeedB
 
FeedDescriptor realtimeMulticastFeed
 
ServiceDescriptor recoveryTcpServiceA
 
ServiceDescriptor recoveryTcpServiceB
 
std::string networkInterfaceForTcpServices
 
std::string recoveryUsername
 
std::string recoveryPassword
 
unsigned short maxPacketSize
 
unsigned int maxConnectingAttempts
 
size_t minReconnectingTimeout
 

Detailed Description

Definition at line 113 of file HandlerSettings.h.

Constructor & Destructor Documentation

HandlerSettings ( )
inline

Constructor.

Definition at line 116 of file HandlerSettings.h.

Member Function Documentation

std::string toString ( ) const
inline

Returns the string representation.

Definition at line 286 of file HandlerSettings.h.

Member Data Documentation

UInt32 heartbeatInterval

Specifies maximal time interval between two network packets. If no data is received during specified time frame, corresponding warning is raised.

Interval is measured in seconds.

Note
The default value is '1'.

Definition at line 189 of file HandlerSettings.h.

std::string licenseDirectory

Path to the license directory.

Definition at line 134 of file HandlerSettings.h.

std::string logDirectory

Log files are stored in this directory.

Definition at line 137 of file HandlerSettings.h.

std::string logFileNamePrefix

Template of log file name without extension.

Definition at line 140 of file HandlerSettings.h.

LogFilePermission::Enum logFilePermissions

Log file permissions.

Note
The default value is ReadAll | WriteOwnerOnly

Definition at line 153 of file HandlerSettings.h.

LogLevel::Enum logLevel

Log verbosity.

Note
The default value is LogLevel::Info

Definition at line 148 of file HandlerSettings.h.

LogSettings::Enum logSettings

Combine LogSettings enum values to configure the logger.

Definition at line 143 of file HandlerSettings.h.

UInt32 lostPacketWaitTime

Indicates for how long Handler should wait for the packet before it's considered as totally lost.

Due to unreliable nature of multicast, data transmitted by MDP may come in order other than original or be completely lost. When Handler receives packet with sequence number greater than expected, it considers received data as out-of-order. If for a certain time interval Handler receives missing data, Handler resumes normal data processing. However, if no data is received for predefined time frame, Handler considers missing data as lost and raises packet gap event. Given parameter defines size of time interval Handler waits for missing data.

Note
When out-of-order packet is received, Handler makes a decision on data loss if either waiting time is over or if newly received packet has sequence number greater than 'seqNumberOfLastReceivedPacket + outOfOrderPacketMaxInterval'.
See also
'outOfOrderPacketMaxInterval' parameter for more information.

Time interval is measured in microseconds (usec).

Note
The default value is '100000' (100 milliseconds).

Definition at line 240 of file HandlerSettings.h.

unsigned int maxConnectingAttempts

Max number of attempts to connect replay and recovery services, default value is 3.

Definition at line 280 of file HandlerSettings.h.

unsigned short maxPacketSize

Max size for network packet transmitted by Eurex.

Definition at line 277 of file HandlerSettings.h.

size_t minReconnectingTimeout

Minimum timeout value between attempts to connect replay and recovery services (sec), default value is 3 sec.

Definition at line 283 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.

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

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

Definition at line 162 of file HandlerSettings.h.

std::string networkInterfaceA

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

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

Note
If the value is empty or absent then the networkInterface_ filled value is used.

Definition at line 171 of file HandlerSettings.h.

std::string networkInterfaceB

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

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

Note
If the value is empty or absent then the networkInterface_ filled value is used.

Definition at line 180 of file HandlerSettings.h.

std::string networkInterfaceForTcpServices

Specifies network interfaces to use while establishing tcp connection.

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

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

Definition at line 268 of file HandlerSettings.h.

UInt32 outOfOrderPacketMaxInterval

Defines value of threshold used by Handler to differ out-of-order packets from gaps.

Due to unreliable nature of multicast, packets transmitted by exchange may be received in the order different to original. To differ the case when Handler received out-of-order packets from the case when some of packets were completely lost, Handler uses given parameter. It defines size of interval for incoming packets starting from the last received. Packet is considered as out-of-order if its sequence number fits into interval [seqNumberOfLastReceivedPacket, seqNumberOfLastReceivedPacket + outOfOrderPacketsMaxInterval]. In that case Handler waits for other packets to fulfill the incoming sequence. If received packet has greater sequence number than 'seqNumberOfLastReceivedPacket + outOfOrderPacketsMaxInterval', then Handler makes a decision on packets lost and gap is reported.

Note
When out-of-order packet is received, Handler makes a decision on data loss if either waiting time is over or if newly received packet has sequence number greater than 'seqNumberOfLastReceivedPacket + outOfOrderPacketMaxInterval'.
See also
'lostPacketWaitTime' parameter for more information.
Note
The default value is '3'.

Definition at line 215 of file HandlerSettings.h.

FeedDescriptor realtimeMulticastFeed

Realtime feed.

Definition at line 253 of file HandlerSettings.h.

std::string recoveryPassword

Password assigned for Recovery Service.

Definition at line 274 of file HandlerSettings.h.

ServiceDescriptor recoveryTcpServiceA

Recovery TCP service A.

Definition at line 256 of file HandlerSettings.h.

ServiceDescriptor recoveryTcpServiceB

Recovery TCP service B.

Definition at line 259 of file HandlerSettings.h.

std::string recoveryUsername

Username assigned for Recovery Service.

Definition at line 271 of file HandlerSettings.h.

bool useFeedA

Option to use feed A.

Note
The default value is 'true'.

Definition at line 245 of file HandlerSettings.h.

bool useFeedB

Option to use feed B.

Note
The default value is 'true'.

Definition at line 250 of file HandlerSettings.h.

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