HandlerSettings Struct Reference

Handler settings. More...

Public Types
typedef std::set< int >	NonReconnectErrorCodes

Public Member Functions
	HandlerSettings ()
	Default constructor.
	HandlerSettings (const std::string &path)
	Read settings from xml-file.
std::string	toString () const
	String representation.

Public Attributes
std::string	logDir
	Path to directory for log files. More...
std::string	logFileNamePrefix
	Template of log file name without extension. More...
LogSwitches::Enum	logSwitches
	Combine LogSwitches enum values to configure the logger. More...
LogLevel::Enum	logLevel
	Log verbosity. More...
std::string	licenseDir
	Directory with the product license. More...
std::string	customerId
	Customer Identification Number. More...
uint32	pollingPeriodMilliseconds
	Polling period in milliseconds. More...
bool	concurrentConnection
	If true handler will try to use concurrent connections for API calls and events reading. More...
ConnectionRetries	connectionRetries
	Connection retries configuration settings. More...
NonReconnectErrorCodes	nonReconnectErrorCodes
	Non-reconnect error codes set. More...

Detailed Description

Handler settings.

Member Data Documentation

bool concurrentConnection

If true handler will try to use concurrent connections for API calls and events reading.

Note

The default value is true.

ConnectionRetries connectionRetries

Connection retries configuration settings.

See also

ConnectionRetries.

std::string customerId

Customer Identification Number.

Used to tag orders with our own order IDs if we so desire.

Note

Used to tag orders with our own order IDs if we so desire.

Maximum 15 characters.

std::string licenseDir

Directory with the product license.

Note

The default value is "." (current dir).

std::string logDir

Path to directory for log files.

Note

The default value is "logs".

std::string logFileNamePrefix

Template of log file name without extension.

Note

The default value is "BrokerTecHandler".

LogLevel::Enum logLevel

Log verbosity.

Note

The default value is LogLevel::Info.

LogSwitches::Enum logSwitches

Combine LogSwitches enum values to configure the logger.

Note

The default value is LogSwitches::Default.

NonReconnectErrorCodes nonReconnectErrorCodes

Non-reconnect error codes set.

This option used to control set of non-reconnect error codes.

By default includes following error codes:

OMNIAPI_INTFAILURE(-2001), OMNIAPI_LOGIN_DISABLED(-2023), OMNIAPI_INVALID_LOGIN_ATTEMPT(-2024), OMNIAPI_INVALID_LOGIN_LOCKED(-2033), OMNIAPI_INVALID_LOGIN_SUSPENDED(-2034), OMNIAPI_RELOGIN_NOT_ALLOWED(-2035), OMNIAPI_INVALID_LOGIN_INACTIVE(-2037).

uint32 pollingPeriodMilliseconds

Polling period in milliseconds.

Note

Permits users to set the polling frequency for retrieve data from exchange.

The default value is 50 milliseconds.