OnixS C++ Cboe CFE Multicast PITCH Market Data Handler  1.9.0
API documentation
Handler Class Reference

#include <OnixS/CboeCFE/MarketData/Pitch/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 registerProtocolListener (ProtocolListener *listener)
 
void registerOrderBookListener (OrderBookListener *listener)
 
void registerMarketByPriceListener (MarketByPriceListener *listener)
 
void registerTradeOnOrderExecutedListener (TradeOnOrderExecutedListener *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 47 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

void bindFeedEngine ( FeedEngine feedEngine)

Binds Feed Engine to the Handler.

Handler must be in stopped state.

Exceptions
OperationExceptionin case when handler is not in configurable state.
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 registerMarketByPriceListener ( MarketByPriceListener listener)

Assigns listener to receive notification about price level updates 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 notification when Pitch messages is 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 registerProtocolListener ( ProtocolListener listener)

Assigns listener to receive notifications about message processing 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 registerTradeOnOrderExecutedListener ( TradeOnOrderExecutedListener listener)

Assigns listener to receive notification additionally generated events 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 ( )

Start handler.

Note
This action is asynchronous.
Exceptions
std::exceptionin case of unable to start.
void start ( const ReplayOptions options)

Starts replaying previously logged data.

HandlerState::Enum state ( ) const

Returns handler state.

void stop ( bool  wait)

Stop handler.

static const char* version ( )
static

Returns Handler's version.


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