HandlerSettings Struct Reference

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
LogFilePermission::Enum	logFilePermissions
std::string	networkInterface
std::string	networkInterfaceA
std::string	networkInterfaceB
UInt32	heartbeatInterval
UInt32	outOfOrderPacketMaxInterval
UInt32	lostPacketWaitTime
bool	useFeedA
bool	useFeedB
FeedDescriptor	realtimeMulticastFeed
FeedDescriptor	snapshotMulticastFeed
size_t	incrementalQueueSize = 100000
UInt32	maxCompatibleSbeVersion

Detailed Description

Definition at line 113 of file HandlerSettings.h.

Constructor & Destructor Documentation

HandlerSettings()

HandlerSettings ( )

inline

Constructor.

Definition at line 116 of file HandlerSettings.h.

Member Function Documentation

toString()

std::string toString ( ) const

inline

Returns the string representation.

Definition at line 285 of file HandlerSettings.h.

Member Data Documentation

heartbeatInterval

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 '3'.

Definition at line 191 of file HandlerSettings.h.

incrementalQueueSize

size_t incrementalQueueSize = 100000

Max incremental queue size.

Definition at line 261 of file HandlerSettings.h.

licenseDirectory

std::string licenseDirectory

Path to the license directory.

Definition at line 136 of file HandlerSettings.h.

licenseString

std::string licenseString

License string.

Definition at line 133 of file HandlerSettings.h.

logDirectory

std::string logDirectory

Log files are stored in this directory.

Definition at line 139 of file HandlerSettings.h.

logFileNamePrefix

std::string logFileNamePrefix

Template of log file name without extension.

Definition at line 142 of file HandlerSettings.h.

logFilePermissions

LogFilePermission::Enum logFilePermissions

Log file permissions.

Note

The default value is ReadAll | WriteOwnerOnly

Definition at line 155 of file HandlerSettings.h.

logLevel

LogLevel::Enum logLevel

Log verbosity.

Note

The default value is LogLevel::Info

Definition at line 150 of file HandlerSettings.h.

logSettings

LogSettings::Enum logSettings

Combine LogSettings enum values to configure the logger.

Definition at line 145 of file HandlerSettings.h.

lostPacketWaitTime

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

maxCompatibleSbeVersion

UInt32 maxCompatibleSbeVersion

Highest SBE message schema version the Handler tolerates as forward-compatible.

When a message arrives with a schema version newer than the one the SDK was compiled against (Messaging::SchemaTraits::Version):

• if it is less than or equal to this value, the Handler logs a one-time advisory at Info level and keeps processing, without invoking the WarningListener;
• if it is greater than this value, the Handler logs a one-time Warning and invokes the WarningListener (legacy behavior).

Older or equal versions are always processed without any advisory.

Note

Meaningful only when raised above the compiled schema version; the value should name a not-yet-compiled schema you expect a given Optiq segment to reach before the SDK is rebuilt.

The default value equals the compiled schema version, which disables forward tolerance and preserves the legacy warning behavior.

Definition at line 282 of file HandlerSettings.h.

networkInterface

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

networkInterfaceA

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

networkInterfaceB

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

outOfOrderPacketMaxInterval

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

realtimeMulticastFeed

FeedDescriptor realtimeMulticastFeed

Realtime feed.

Definition at line 255 of file HandlerSettings.h.

snapshotMulticastFeed

FeedDescriptor snapshotMulticastFeed

Snapshot feed.

Definition at line 258 of file HandlerSettings.h.

useFeedA

bool useFeedA

Option to use feed A.

Note

The default value is 'true'.

Definition at line 247 of file HandlerSettings.h.

useFeedB

bool useFeedB

Option to use feed B.

Note

The default value is 'true'.

Definition at line 252 of file HandlerSettings.h.