OnixS SWXess Market Data Handler for C++  1.0.0.0
Public Member Functions | Static Public Member Functions | List of all members
Handler Class Reference

SWXess Market Data Handler class. More...

Public Member Functions

 Handler (const HandlerSettings &settings)
 Performs instance initialization. More...
 
virtual ~Handler ()
 Finalizes the Handler.
 
void registerErrorListener (ErrorListener *listener)
 Assigns listener for errors occurred while executing handler. More...
 
void registerWarningListener (WarningListener *listener)
 Assigns listener for warnings occurred while executing handler. More...
 
void registerOrderBookListener (OrderBookListener *listener)
 Assigns a listener for PriceLevel order book events occurring while executing the handler. More...
 
void registerMessageListener (MessageListener *listener)
 Assigns a listener for messages.
 
void start (bool naturalRefreshMode=false)
 Start the handler. More...
 
void start (const ReplayOptions &options)
 Starts replaying previously logged data.
 
void stop (bool wait)
 Stop handler.
 
HandlerState::Enum state () const
 Returns handler state.
 
void log (LogLevel::Enum logLevel, const char *logMessage, size_t length)
 Logs the given user-level message to the handler log.
 
void log (LogLevel::Enum logLevel, const char *logMessage)
 Logs the given user-level message to the handler log.
 
void log (LogLevel::Enum logLevel, const std::string &str)
 Logs the given user-level message to the handler log.
 
const char * licenseExpirationDate () const
 Returns the license expiration date.
 
const HandlerSettingssettings () const
 Returns handler settings.
 

Static Public Member Functions

static const char * version ()
 Returns Handler's version.
 

Detailed Description

SWXess Market Data Handler class.

Constructor & Destructor Documentation

Handler ( const HandlerSettings settings)

Performs instance initialization.

Parameters
modedefines the data channel mode to be used
settingsdefines values for various options which affect handler behavior like enabling logging during execution of the handler.

Member Function Documentation

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
OperationExceptionif handler not disconnected
void registerOrderBookListener ( OrderBookListener listener)

Assigns a listener for PriceLevel order book events occurring while executing the handler.

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

Exceptions
OperationExceptionif handler not disconnected.
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
OperationExceptionif handler not disconnected
void start ( bool  naturalRefreshMode = false)

Start the handler.

Note
This action is asynchronous.
Exceptions
std::exceptionin case of unable to start.