Handler Class Reference

#include <OnixS/B3/MarketData/UMDF/Handler.h>

Public Member Functions
	Handler (const HandlerSettings &settings)
virtual	~Handler ()
void	registerErrorListener (ErrorListener *listener)
void	registerWarningListener (WarningListener *listener)
void	registerHandlerStateListener (HandlerStateListener *listener)
void	registerMessageListener (MessageListener *listener)
void	registerOrderBookListener (OrderBookListener *listener)
void	start ()
void	stop (bool wait)
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)
std::string	licenseExpirationDate () const
void	replayLogs (const ReplayOptions &options)
void	replayPcap (const ReplayOptions &options, const FilesList &instrument, const FilesList &snapshot)
Handler &	subscribe (Messaging::SecurityID securityId)
Handler &	subscribe (std::initializer_list< Messaging::SecurityID > securityIds)
Handler &	unsubscribe (Messaging::SecurityID securityId)
Handler &	unsubscribe (std::initializer_list< Messaging::SecurityID > securityIds)

Static Public Member Functions
static const char *	version ()

Friends
struct	Implementation::ReplayHelper

Detailed Description

Definition at line 49 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

Finalizes the Handler.

Member Function Documentation

licenseExpirationDate()

std::string licenseExpirationDate

(

)

const

Returns the license expiration date.

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.

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 it 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 it is in disconnected state.

Exceptions

OperationException

if handler not disconnected.

registerMessageListener()

void registerMessageListener

(

MessageListener *

listener

)

Assigns listener to receive notifications when market data messages are received while executing handler.

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

Exceptions

OperationException

if handler not disconnected.

registerOrderBookListener()

void registerOrderBookListener

(

OrderBookListener *

listener

)

Assigns listener to receive notification about order book states while executing handler.

It's permissible to change the listener multiple times during handler's life-time, but only when it 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 it is in disconnected state.

Exceptions

OperationException

if handler not disconnected

replayLogs()

void replayLogs

(

const ReplayOptions &

options

)

Starts replaying previously logged data.

replayPcap()

void replayPcap	(	const ReplayOptions &	options,
		const FilesList &	instrument,
		const FilesList &	snapshot )

Replay pcap files.

start()

void start

(

)

Start handler.

Note

This action is asynchronous.

Exceptions

std::exception

in case of unable to start.

state()

HandlerState::Enum state

(

)

const

Returns handler state.

stop()

void stop

(

bool

wait

)

Stop handler.

subscribe() [1/2]

Handler & subscribe

(

Messaging::SecurityID

securityId

)

Adds security id to the security filter.

subscribe() [2/2]

Handler & subscribe

(

std::initializer_list< Messaging::SecurityID >

securityIds

)

Adds a few security ids to the security filter.

unsubscribe() [1/2]

Handler & unsubscribe

(

Messaging::SecurityID

securityId

)

Removes security id from the security filter.

unsubscribe() [2/2]

Handler & unsubscribe

(

std::initializer_list< Messaging::SecurityID >

securityIds

)

Removes a few security ids from the security filter.

version()

const char * version ( )

static

Returns Handler's version.

Friends And Related Symbol Documentation

Implementation::ReplayHelper

friend struct Implementation::ReplayHelper

friend

Definition at line 142 of file Handler.h.