Handler Class Reference

Public Member Functions
	Handler (const HandlerSettings &settings)
virtual	~Handler ()
void	connect (const char *hostName, UInt16 port, const Logon &logon, const char *localNetworkInterface="")
void	connect (const char *primaryHostName, UInt16 primaryPort, const char *secondaryHostName, UInt16 secondaryPort, const Logon &logon, const char *localNetworkInterface="")
void	disconnect ()
void	disconnectAsync ()
UInt32	send (Message &)
size_t	tryThrottle ()
void	registerErrorListener (ErrorListener *listener)
void	registerWarningListener (WarningListener *listener)
void	registerHandlerStateListener (HandlerStateListener *listener)
void	registerSessionListener (SessionListener *listener)
void	registerConnectionStateListener (ConnectionStateListener *listener)
void	registerAdminListener (AdminListener *listener)
void	registerStrategyCreationListener (StrategyCreationListener *listener)
void	registerOrderHandlingListener (OrderHandlingListener *listener)
void	registerQuoteAndCrossRequestListener (QuoteAndCrossRequestListener *listener)
void	registerQuoteHandlingListener (QuoteHandlingListener *listener)
void	registerInfoListener (InfoListener *listener)
void	registerTESListener (TESListener *listener)
void	registerSRQSListener (SRQSListener *listener)
HandlerState::Enum	state () const
void	log (LogLevel::Enum logLevel, const char *logMessage, size_t length)
void	log (LogLevel::Enum logLevel, const char *logMessage)
void	log (LogLevel::Enum logLevel, const std::string &str)
const std::string &	licenseExpirationDate () const

Static Public Member Functions
static std::string	encryptPassword (const std::string &password, const std::string &pubKeyPath)
static const std::string &	version ()

Detailed Description

Definition at line 47 of file Handler.h.

Constructor & Destructor Documentation

Handler()

Handler

(

const HandlerSettings &

settings

)

Performs instance initialization.

Parameters

settings

defines values for various options which affect handler behavior like enabling logging during execution of the handler.

~Handler()

virtual ~Handler ( )

virtual

Finalizes the Handler.

Member Function Documentation

connect() [1/2]

void connect	(	const char *	hostName,
		UInt16	port,
		const Logon &	logon,
		const char *	localNetworkInterface = "" )

Establishes the connection.

Note

Blocks until the logon reply is received.

Should be called only when Handler is disconnected.

Parameters

hostName	Hostname to connect to.
port	Port number to connect to.
logon	Initial logon message parameters.
localNetworkInterface	Local network interface.

Exceptions

std::exception	Cannot set the local network interface.
std::exception	Cannot connect to hostname on port.
std::exception	Cannot configure size of receive buffer for the socket.
std::exception	Cannot configure size of send buffer for the socket.
OperationException	Invalid argument is given.

connect() [2/2]

void connect	(	const char *	primaryHostName,
		UInt16	primaryPort,
		const char *	secondaryHostName,
		UInt16	secondaryPort,
		const Logon &	logon,
		const char *	localNetworkInterface = "" )

Establishes the connection.

Note

Blocks until the logon reply is received.

Should be called only when Handler is disconnected.

Parameters

primaryHostName	Primary hostname to connect to.
primaryPort	Primary port number to connect to.
secondaryHostName	Secondary hostname to connect to.
secondaryPort	Secondary port number to connect to.
logon	Initial logon message parameters.
localNetworkInterface	Local network interface.

Exceptions

std::exception	Cannot set the local network interface.
std::exception	Cannot connect to hostname on port.
std::exception	Cannot configure size of receive buffer for the socket.
std::exception	Cannot configure size of send buffer for the socket.
OperationException	Invalid argument is given.

disconnect()

void disconnect

(

)

Force session disconnect.

Note

Blocks until the Session Logout procedure is finished.

disconnectAsync()

void disconnectAsync

(

)

Async force session disconnect.

encryptPassword()

std::string encryptPassword ( const std::string & password, const std::string & pubKeyPath )

static

Encrypts the given password using the given key.

Parameters

password	Password to encrypt.
pubKeyPath	Path to the RSA public key file.

Returns

Encrypted and Base64-encoded password.

licenseExpirationDate()

const std::string & licenseExpirationDate

(

)

const

Returns the license expiration date.

Date format is YYYYMMDD.

log() [1/3]

void log	(	LogLevel::Enum	logLevel,
		const char *	logMessage )

Logs the given user-level message to the handler log.

log() [2/3]

void log	(	LogLevel::Enum	logLevel,
		const char *	logMessage,
		size_t	length )

Logs the given user-level message to the handler log.

log() [3/3]

void log	(	LogLevel::Enum	logLevel,
		const std::string &	str )

Logs the given user-level message to the handler log.

registerAdminListener()

void registerAdminListener

(

AdminListener *

listener

)

Assigns listener for administrative events. It's permissible to change the listener multiple times during handler's life-time, but only when handler is in disconnected state.

Exceptions

OperationException

if handler not disconnected.

registerConnectionStateListener()

void registerConnectionStateListener

(

ConnectionStateListener *

listener

)

Assigns listener for connection state change events occurred while executing handler. It's permissible to change the listener multiple times during handler's life-time, but only when handler is in disconnected state.

Exceptions

OperationException

if handler not disconnected.

registerErrorListener()

void registerErrorListener

(

ErrorListener *

listener

)

Assigns listener for errors occurred while executing handler. It's permissible to change the listener multiple times during handler's life-time, but only when handler is in disconnected state.

Exceptions

OperationException

if handler not disconnected

registerHandlerStateListener()

void registerHandlerStateListener

(

HandlerStateListener *

listener

)

Assigns listener for state change events occurred while executing handler. It's permissible to change the listener multiple times during handler's life-time, but only when handler is in disconnected state.

Exceptions

OperationException

if handler not disconnected.

registerInfoListener()

void registerInfoListener

(

InfoListener *

listener

)

Assigns listener for other events. It's permissible to change the listener multiple times during handler's life-time, but only when handler is in disconnected state.

Exceptions

OperationException

if handler not disconnected.

registerOrderHandlingListener()

void registerOrderHandlingListener

(

OrderHandlingListener *

listener

)

Assigns listener for order handling events. It's permissible to change the listener multiple times during handler's life-time, but only when handler is in disconnected state.

Exceptions

OperationException

if handler not disconnected.

registerQuoteAndCrossRequestListener()

void registerQuoteAndCrossRequestListener

(

QuoteAndCrossRequestListener *

listener

)

Assigns listener for quote and cross request events. It's permissible to change the listener multiple times during handler's life-time, but only when handler is in disconnected state.

Exceptions

OperationException

if handler not disconnected.

registerQuoteHandlingListener()

void registerQuoteHandlingListener

(

QuoteHandlingListener *

listener

)

Assigns listener for quote handling events. It's permissible to change the listener multiple times during handler's life-time, but only when handler is in disconnected state.

Exceptions

OperationException

if handler not disconnected.

registerSessionListener()

void registerSessionListener

(

SessionListener *

listener

)

Assigns listener for session events occurred while executing handler. It's permissible to change the listener multiple times during handler's life-time, but only when handler is in disconnected state.

Exceptions

OperationException

if handler not disconnected.

registerSRQSListener()

void registerSRQSListener

(

SRQSListener *

listener

)

Assigns listener for SRQS events. It's permissible to change the listener multiple times during handler's life-time, but only when handler is in disconnected state.

Exceptions

OperationException

if handler not disconnected.

registerStrategyCreationListener()

void registerStrategyCreationListener

(

StrategyCreationListener *

listener

)

Assigns listener for strategy creation events. It's permissible to change the listener multiple times during handler's life-time, but only when handler is in disconnected state.

Exceptions

OperationException

if handler not disconnected.

registerTESListener()

void registerTESListener

(

TESListener *

listener

)

Assigns listener for TES events. It's permissible to change the listener multiple times during handler's life-time, but only when handler is in disconnected state.

Exceptions

OperationException

if handler not disconnected.

registerWarningListener()

void registerWarningListener

(

WarningListener *

listener

)

Assigns listener for warnings occurred while executing handler. It's permissible to change the listener multiple times during handler's life-time, but only when handler is in disconnected state.

Exceptions

OperationException

if handler not disconnected

send()

UInt32 send

(

Message &

)

Send message

Returns

MsgSeqNum

Exceptions

OperationException	Attempt to send data before connection creation
std::exception	with system dependent message if sending has been failed

state()

HandlerState::Enum state

(

)

const

Returns handler state.

tryThrottle()

size_t tryThrottle

(

)

Checks the throttling of a session that must be called before each send function call.

If the count of messages per time unit exceeds the throttling limit, the function returns the delay (in milliseconds) until the sending becomes possible. Otherwise, it returns 0.

Note

This call is thread-safe.

version()

const std::string & version ( )

static

Returns Handler's version.