HandlerSettings Struct Reference

Public Member Functions
	HandlerSettings ()

Public Attributes
std::string	licenseString
std::string	licenseDirectory
std::string	logDirectory
std::string	logFileNamePrefix
LogSettings::Enum	logSettings
LogLevel::Enum	logLevel
std::string	networkInterface
std::string	networkInterfaceA
std::string	networkInterfaceB
bool	useFeedA
bool	useFeedB
unsigned int	heartbeatInterval
unsigned int	lostPacketWaitTime
unsigned int	outOfOrderPacketMaxInterval
unsigned int	messagePoolSize

Detailed Description

Definition at line 118 of file HandlerSettings.h.

Constructor & Destructor Documentation

HandlerSettings ( )

inline

Constructor.

Definition at line 121 of file HandlerSettings.h.

Member Data Documentation

unsigned int 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 '20'.

Definition at line 199 of file HandlerSettings.h.

std::string licenseDirectory

Path to the license directory.

Definition at line 141 of file HandlerSettings.h.

std::string licenseString

License string.

Definition at line 138 of file HandlerSettings.h.

std::string logDirectory

Log files are stored in this directory.

Definition at line 144 of file HandlerSettings.h.

std::string logFileNamePrefix

Template of log file name without extension.

Definition at line 147 of file HandlerSettings.h.

LogLevel::Enum logLevel

Log verbosity.

Note

The default value is LogLevel::Info

Definition at line 155 of file HandlerSettings.h.

LogSettings::Enum logSettings

Combine LogSettings enum values to configure the logger.

Definition at line 150 of file HandlerSettings.h.

unsigned int 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 the Eurex T7 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.

See also

'outOfOrderPacketMaxInterval' parameter for more information.

Time interval is measured in milliseconds.

Note

The default value is 500 milliseconds.

Definition at line 218 of file HandlerSettings.h.

unsigned int messagePoolSize

Defines size of buffer in bytes for message caching.

Note

Default value is 512000 bytes.

Definition at line 249 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 163 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 179 of file HandlerSettings.h.

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

bool useFeedA

Option to use feed A.

Note

The default value is 'true'.

Definition at line 184 of file HandlerSettings.h.

bool useFeedB

Option to use feed B.

Note

The default value is 'true'.

Definition at line 189 of file HandlerSettings.h.