HandlerSettings Struct Reference

Handler base configuration settings. More...

List of all members.

Public Member Functions
	HandlerSettings ()
	Constructor.
std::string	toString () const
	Returns the string representation.
Public Attributes
std::string	licenseDirectory
	Path to the license directory.
std::string	logDirectory
	Log files are stored in this directory.
std::string	logFileNamePrefix
	Template of log file name without extension.
LogSettings::Enum	logSettings
	Combine LogSettings enum values to configure the logger.
LogLevel::Enum	logLevel
	Log verbosity.
LogFilePermission::Enum	logFilePermissions
	Log file permissions.
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.
std::string	networkInterfaceA
	Specifies one or more network interfaces to use while joining the multicast group; use semi-colon delimited list if more than one.
std::string	networkInterfaceB
	Specifies one or more network interfaces to use while joining the multicast group; use semi-colon delimited list if more than one.
unsigned int	maxPacketWaitingTime
	Specifies the maximum time interval (milliseconds) to wait out-of-sequence packet before treating it as totally lost.
bool	useFeedA
	Option to use feed A.
bool	useFeedB
	Option to use feed B.
FeedDescriptor	multicastFeed
	Multicast IP Addresses.
ServiceDescriptor	retransmitionServer
	Retransmission Server.
ThreadAffinity	threadAffinity
	Defines set of CPUs by their indices (starting from zero) allowed for each receiving thread used by the Handler.
size_t	udpSocketBufferSize
	Defines size of buffer in bytes for UDP/multicast sockets.
size_t	feedInactivityTimeout
	Indicates for how long till onDepthSnapshot::onDepthOutOfDate and OrderBookListener::onOrderBookOutOfDate will be fired if no UDP data in incremental streams.
size_t	maxBooksObjectAmount
	Defines size of preallocated memory for Order Book. Default value is 100.
bool	buildInternalOrderBooks
	Build internal books.
size_t	maxRecoveryTime
	Maximum timeout to recovery (sec), default value is 120 sec.

---

Detailed Description

Handler base configuration settings.

---

Member Data Documentation

size_t feedInactivityTimeout

Indicates for how long till onDepthSnapshot::onDepthOutOfDate and OrderBookListener::onOrderBookOutOfDate will be fired if no UDP data in incremental streams.

Value must be specified in seconds (sec).

Note:

The default value is 20 sec.

LogFilePermission::Enum logFilePermissions

Log file permissions.

Note:

The default value is ReadAll | WriteOwnerOnly

LogLevel::Enum logLevel

Log verbosity.

Note:

The default value is LogLevel::Info

unsigned int maxPacketWaitingTime

Specifies the maximum time interval (milliseconds) to wait out-of-sequence packet before treating it as totally lost.

Note:

The default value is 500 milliseconds.

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.

std::string networkInterfaceA

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.

std::string networkInterfaceB

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.

ThreadAffinity threadAffinity

Defines set of CPUs by their indices (starting from zero) allowed for each receiving thread used by the Handler.

Note:

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

size_t udpSocketBufferSize

Defines size of buffer in bytes for UDP/multicast sockets.

Note:

Default value is zero which means system default setting will be used.

bool useFeedA

Option to use feed A.

Note:

The default value is 'true'.

bool useFeedB

Option to use feed B.

Note:

The default value is 'true'.