Handler Class Reference

Public Member Functions
	Handler (const HandlerSettings &settings)
virtual	~Handler ()
void	connect (const LogonSettings &logonSettings, const std::string &hostName, Port port, const std::string &localNetworkInterface="", const PortRange &localPortRange=PortRange(0, 0))
void	disconnect ()
void	disconnectAsync ()
Port	localPort ()
void	registerErrorListener (ErrorListener *listener)
void	registerWarningListener (WarningListener *listener)
void	registerHandlerStateListener (HandlerStateListener *listener)
void	registerSessionListener (SessionListener *listener)
void	registerMessageListener (MessageListener *listener)
void	registerReplayListener (ReplayListener *listener)
UInt32	send (const OutgoingMessage &)
void	warmup (OutgoingMessage &, int warmupFlags=0)
void	nextSendingSeqNum (SeqNumber value)
SeqNumber	nextSendingSeqNum ()
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 const std::string	version ()

Detailed Description

OnixS CBOE CFE Binary Order Entry (BOE) Handler

Definition at line 50 of file Handler.h.

Constructor & Destructor Documentation

Handler()

Handler ( const HandlerSettings & settings )

explicit

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

Member Function Documentation

connect()

void connect	(	const LogonSettings &	logonSettings,
		const std::string &	hostName,
		Port	port,
		const std::string &	localNetworkInterface = "",
		const PortRange &	localPortRange = PortRange(0, 0) )

Establishes the connection.

Note

Blocks until the logon reply is received.

Should be called only when Handler is disconnected.

Parameters

logonSettings	Initial logon message parameters.
hostName	Hostname to connect to.
port	Port number to connect to.
localNetworkInterface	Local network interface.
localPortRange	Range to choose local port from.

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.

licenseExpirationDate()

const std::string & licenseExpirationDate

(

)

const

Returns the license expiration date.

localPort()

Port localPort

(

)

Returns

the local network port number.

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.

nextSendingSeqNum() [1/2]

SeqNumber nextSendingSeqNum

(

)

Gets the next sequence number for sending messages.

nextSendingSeqNum() [2/2]

void nextSendingSeqNum

(

SeqNumber

value

)

Sets the next sequence number for sending messages.

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.

registerMessageListener()

void registerMessageListener

(

MessageListener *

listener

)

Assigns listener for message 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.

registerReplayListener()

void registerReplayListener

(

ReplayListener *

listener

)

Assigns listener for message 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.

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.

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

(

const OutgoingMessage &

)

state()

HandlerState::Enum state

(

)

const

Returns handler state.

version()

const std::string version ( )

static

Returns Handler's version.

warmup()

void warmup	(	OutgoingMessage &	,
		int	warmupFlags = 0 )