Handler Class Reference

Public Member Functions
	Handler (const HandlerSettings &settings, const std::string &=("Unknown"))
virtual	~Handler ()
void	registerErrorListener (ErrorListener *listener)
void	registerWarningListener (WarningListener *listener)
void	registerHandlerStateListener (HandlerStateListener *listener)
void	registerMessageListener (MessageListener *listener)
void	bindFeedEngine (FeedEngine &feedEngine)
void	start ()
void	start (const ReplayOptions &options)
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

Static Public Member Functions
static const char *	version ()

Detailed Description

Definition at line 43 of file Handler.h.

Constructor & Destructor Documentation

Handler()

Handler ( const HandlerSettings & settings, const std::string & = ("Unknown") )

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

bindFeedEngine()

void bindFeedEngine

(

FeedEngine &

feedEngine

)

Binds Feed Engine to the Handler.

Handler must be in stopped state.

Exceptions

OperationException

in case when handler is not in configurable state.

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 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 to receive notification when Optiq MDG messages are received 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

start() [1/2]

void start

(

)

Start handler.

Note

This action is asynchronous.

Exceptions

std::exception

in case of unable to start.

start() [2/2]

void start

(

const ReplayOptions &

options

)

Starts replaying previously logged data.

state()

HandlerState::Enum state

(

)

const

Returns handler state.

stop()

void stop

(

bool

wait

)

Stop handler.

version()

const char * version ( )

static

Returns Handler's version.