Handler Class Reference

Public Member Functions
	Handler (const HandlerSettings &settings)
virtual	~Handler ()
void	registerErrorListener (ErrorListener *listener)
void	registerWarningListener (WarningListener *listener)
void	registerHandlerStateListener (HandlerStateListener *listener)
void	registerRecordListener (RecordListener *listener)
void	connect (const std::string &host, int port)
void	disconnect ()
void	subscribe (FieldId fieldId)
void	unsubscribe (FieldId fieldId)
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 char *	licenseExpirationDate () const

Static Public Member Functions
static const char *	version ()

Detailed Description

Definition at line 36 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()

void connect	(	const std::string &	host,
		int	port )

Connects the Handler to the given host and port.

Exceptions

std::exception

in case of unable to establish TCP connection.

disconnect()

void disconnect

(

)

Disconnects the Handler.

licenseExpirationDate()

const char * 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.

registerRecordListener()

void registerRecordListener

(

RecordListener *

listener

)

Assigns listener for records 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

state()

HandlerState::Enum state

(

)

const

Returns handler state.

subscribe()

void subscribe

(

FieldId

fieldId

)

Subscribes to the records with given field ID.

Parameters

fieldId

- identifier of field.

Exceptions

ArgumentRangeException

if fieldId is not in valid range.

unsubscribe()

void unsubscribe

(

FieldId

fieldId

)

Unsubscribes for the records with given field ID.

Parameters

fieldId

- identifier of field.

Exceptions

ArgumentRangeException

if fieldId is not in valid range.

version()

const char * version ( )

static

Returns Handler's version.