OnixS C++ CME MDP Premium Market Data Handler 5.11.1
Users' manual and API documentation
Loading...
Searching...
No Matches
Handler Class Reference

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

Public Member Functions

 Handler (std::string=(""))
 Handler (const MemoryPoolSettings &, std::string=(""))
 Handler (const HandlerSettings &, std::string=(""))
 ~Handler ()
HandlerSettings & settings ()
const HandlerSettings & settings () const
void selectInstruments (const InstrumentSelection &)
void clearInstrumentCache ()
void start ()
void stop ()
std::string licenseExpirationDate () const

Friends

class PcapReplayHelper

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() [1/3]

Handler ( std::string = (""))

Initializes the instance with the default settings.

◆ Handler() [2/3]

Handler ( const MemoryPoolSettings & ,
std::string = ("") )
explicit

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

◆ Handler() [3/3]

Handler ( const HandlerSettings & ,
std::string = ("") )
explicit

Initializes the instance according to the given settings.

◆ ~Handler()

~Handler ( )

Finalizes the instance.

Member Function Documentation

◆ clearInstrumentCache()

void clearInstrumentCache ( )

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

◆ licenseExpirationDate()

std::string licenseExpirationDate ( ) const

Returns the license expiration date.

◆ selectInstruments()

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.

◆ settings() [1/2]

HandlerSettings & settings ( )

The configuration parameters of the given instance.

◆ settings() [2/2]

const HandlerSettings & settings ( ) const

Immutable configuration of the given instance.

◆ start()

void start ( )

Starts market data processing if the handler is stopped.

Exceptions
std::exceptionIf license validation fails.
Note
Preparation failures are reported through HandlerListener::onError with Issue::OperationFailure, followed by HandlerListener::onStopped, synchronously before this call returns. A normal return does not establish successful startup or data readiness. onStarted precedes feed connection; connection failures can report Issue::ConnectionFailure without stopping.
Each call checks the license, including when already running. Invoke lifecycle operations outside callbacks; see Operations from callbacks.
See also
Observing startup

◆ stop()

void stop ( )

Stops a processing handler; has no effect when already stopped.

Note
Shutdown callbacks run synchronously on the calling thread. The handler becomes configurable after onStopped returns. Call from outside callbacks and serialize lifecycle operations in the application.
See also
Operations from callbacks

◆ PcapReplayHelper

friend class PcapReplayHelper
friend

Definition at line 266 of file Handler.h.