OnixS C++ CME Market Data Handler  5.4.0
API documentation
Handler Class Reference

#include <OnixS/CME/MDH/Handler.h>

Public Member Functions

 Handler ()
 
 Handler (const MemoryPoolSettings &)
 
 Handler (const HandlerSettings &)
 
 ~Handler ()
 
HandlerSettingssettings ()
 
const HandlerSettingssettings () const
 
Loggerlogger ()
 
void selectInstruments (const InstrumentSelection &)
 
void clearInstrumentCache ()
 
void registerListener (HandlerListener &listener)
 
void registerFeedListener (ChannelFeedListener &listener)
 
void registerMarketDataListener (MarketDataListener &listener)
 
void registerSecurityListener (SecurityListener &listener)
 
void bindFeedEngine (NetFeedEngine &feedEngine)
 
void bindTcpRecovery (TcpRecoveryService &tcpRecovery)
 
void bindLogger (Logger &logger)
 
void start ()
 
void start (const SessionSettings &)
 
void stop ()
 

Detailed Description

Encapsulates all the machinery related with market data processing from CME Market Data Platform.

Definition at line 55 of file Handler.h.

Constructor & Destructor Documentation

Handler ( )

Initializes the instance with the default settings.

Handler ( const MemoryPoolSettings )

Initializes instance with the memory pool configured according to the given settings.

Handler ( const HandlerSettings )

Initializes the instance according to the given settings.

Warning
The given member is deprecated. The Handler configuration can be updated any time through the settings() member when the Handler does not process market data.
~Handler ( )

Finalizes the instance.

Member Function Documentation

void bindFeedEngine ( NetFeedEngine feedEngine)

Binds Feed Engine to the Handler.

Handler must be in stopped state.

Exceptions
std::exceptionin case when handler is not in configurable state.
Warning
The given member is deprecated. Use settings().feeds().engine() member to assign the feed engine used by the Handler while manipulating the feeds.
void bindLogger ( Logger logger)

Binds Logging Service to the Handler.

Handler must be in stopped state.

Exceptions
std::exceptionin case when handler is not in configurable state.
Warning
The given member is deprecated. Use settings().logging().logger() member to assign the Logger instance used by the Handler to log various events.
void bindTcpRecovery ( TcpRecoveryService tcpRecovery)

Binds TCP Recovery Service to the Handler.

Handler must be in stopped state.

Exceptions
std::exceptionin case when handler is not in configurable state.
Warning
The given member is deprecated. Use settings().session().tcpRecovery().service() member to assign the TCP recovery service used by the Handler to request missing packets.
void clearInstrumentCache ( )

Erases instrument definitions cache if used. Handler will produce a new cache at next start.

Logger& logger ( )

Logger currently used by the Handler.

Warning
The given member is deprecated. Use settings().logging().logger() member to access the Logger instance used by the Handler while logging its events.
void registerFeedListener ( ChannelFeedListener listener)

Registers feed event listener.

Only single instance of listener can be associated with the Handler. Registering new listener removes previous one. Listener instance lifetime shall be not less than Handler's one.

Listeners are to be associated before starting market data processing - Handler must be in stopped state.

Exceptions
std::exceptionin case when handler is not in configurable state.
Warning
The given member is deprecated. Use settings().listeners().feeds() member to assign the listener for the desired events.
void registerListener ( HandlerListener listener)

Registers Handler events listener.

Only single instance of listener can be associated with the Handler. Registering new listener removes previous one. Listener instance lifetime shall be not less than Handler's one.

Listeners are to be associated before starting market data processing - Handler must be in stopped state.

Exceptions
std::exceptionin case when handler is not in configurable state.
Warning
The given member is deprecated. Use settings().listeners().handler() member to assign the listener for the desired events.
void registerMarketDataListener ( MarketDataListener listener)

Registers market data processing listener.

Only single instance of listener can be associated with the Handler. Registering new listener removes previous one. Listener instance lifetime shall be not less than Handler's one.

Listeners are to be associated before starting market data processing - Handler must be in stopped state.

Exceptions
std::exceptionin case when handler is not in configurable state.
Warning
The given member is deprecated. Use settings().listeners().marketData() member to assign the listener for the desired events.
void registerSecurityListener ( SecurityListener listener)

Registers security events listener.

Only single instance of listener can be associated with the Handler. Registering new listener removes previous one. Listener instance lifetime shall be not less than Handler's one.

Listeners are to be associated before starting market data processing - Handler must be in stopped state.

Exceptions
std::exceptionin case when handler is not in configurable state.
Warning
The given member is deprecated. Use settings().listeners().security() member to assign the listener for the desired events.
void selectInstruments ( const InstrumentSelection )

Filters instruments whose market data is to be processed and events are to be fired by the Handler.

Warning
Instrument selection can be updated only when market data processing is not performed by the Handler or upon successful instrument recovery completion.
HandlerSettings& settings ( )

The configuration parameters of the given instance.

const HandlerSettings& settings ( ) const

Immutable configuration of the given instance.

void start ( )

Starts market data processing.

void start ( const SessionSettings )

Updates the session configuration according to the given settings and starts market data processing.

Warning
The given member is deprecated. Use settings().session() member to update session-related configuration and start() member to launch market data processing.
void stop ( )

Stops market data processing.


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