OnixS C++ B3 Binary UMDF Market Data Handler  1.4.2
API documentation
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)
 
Handlersubscribe (Messaging::SecurityID securityId)
 
Handlersubscribe (std::initializer_list< Messaging::SecurityID > securityIds)
 
Handlerunsubscribe (Messaging::SecurityID securityId)
 
Handlerunsubscribe (std::initializer_list< Messaging::SecurityID > securityIds)
 

Static Public Member Functions

static const char * version ()
 

Friends

struct Implementation::PcapReplayHelper
 

Detailed Description

Definition at line 49 of file Handler.h.

Constructor & Destructor Documentation

Handler ( const HandlerSettings settings)
explicit

Performs instance initialization.

Parameters
settingsdefines values for various options which affect handler behavior like enabling logging during execution of the handler.
virtual ~Handler ( )
virtual

Finalizes the Handler.

Member Function Documentation

std::string licenseExpirationDate ( ) const

Returns the license expiration date.

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.

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 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
OperationExceptionif handler not disconnected.
void registerMessageListener ( MessageListener listener)

Assigns listener to receive notifications 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
OperationExceptionif handler not disconnected.
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 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 replayLogs ( const ReplayOptions options)

Starts replaying previously logged data.

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

Replay pcap files.

void start ( )

Start handler.

Note
This action is asynchronous.
Exceptions
std::exceptionin case of unable to start.
HandlerState::Enum state ( ) const

Returns handler state.

void stop ( bool  wait)

Stop handler.

Handler& subscribe ( Messaging::SecurityID  securityId)

Adds security id to the security filter.

Handler& subscribe ( std::initializer_list< Messaging::SecurityID securityIds)

Adds a few security ids to the security filter.

Handler& unsubscribe ( Messaging::SecurityID  securityId)

Removes security id from the security filter.

Handler& unsubscribe ( std::initializer_list< Messaging::SecurityID securityIds)

Removes a few security ids from the security filter.

static const char* version ( )
static

Returns Handler's version.

Friends And Related Function Documentation

friend struct Implementation::PcapReplayHelper
friend

Definition at line 142 of file Handler.h.


The documentation for this class was generated from the following file: