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

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

Public Member Functions

 BookManagement (SettingChangeController *controller=nullptr)
 BookManagement (const BookManagement &other)
 ~BookManagement ()=default
const MboBookManagement & mboBooks () const noexcept
MboBookManagement & mboBooks () noexcept
const DirectBookManagement & directBooks () const noexcept
DirectBookManagement & directBooks () noexcept
const ImpliedBookManagement & impliedBooks () const noexcept
ImpliedBookManagement & impliedBooks () noexcept
const ConsolidatedBookManagement & consolidatedBooks () const noexcept
ConsolidatedBookManagement & consolidatedBooks () noexcept
BookUpdateNotification::Enum updateNotification () const noexcept
BookManagement & updateNotification (BookUpdateNotification::Enum value)
BookManagement & operator= (const BookManagement &other)
Public Member Functions inherited from SettingGroup
 SettingGroup (SettingChangeController *controller=nullptr)
 ~SettingGroup ()=default
template<class Assignee, class Value>
void controlAssignment (const Messaging::Char *description, Assignee &assignee, Value value) const
template<class Changeable>
void controlChange (const Messaging::Char *description, void(Changeable::*change)(), Changeable &changeable) const
template<class Change, class Changeable, class Arg>
void controlChange (const Messaging::Char *description, Change change, Changeable &changeable, const Arg &arg) const
template<class Change, class Changeable, class Arg1, class Arg2>
void controlChange (const Messaging::Char *description, Change change, Changeable &changeable, const Arg1 &arg1, const Arg2 &arg2) const

Friends

class HandlerSettings

Additional Inherited Members

Static Public Member Functions inherited from SettingGroup
static const SettingGroup & null () noexcept

Detailed Description

The settings control which book types are maintained, how BBO threshold tracking is applied, and when book update callbacks are raised.

Definition at line 947 of file BookManagement.h.

Constructor & Destructor Documentation

◆ BookManagement() [1/2]

BookManagement ( SettingChangeController * controller = nullptr)
inline

Initializes book management settings with defaults.

By default, direct and implied books have fallback depths of 10 and 2 respectively, update notifications are raised at the end of an event, and book maintenance is disabled by each per-book setting.

Parameters
controllerOptional controller used to validate and control setting changes.

Definition at line 958 of file BookManagement.h.

◆ BookManagement() [2/2]

BookManagement ( const BookManagement & other)
inline

Copies book management settings from another instance.

Parameters
otherSource settings.
Note
Assignment-control state is not copied; only setting values are copied.

Definition at line 972 of file BookManagement.h.

◆ ~BookManagement()

~BookManagement ( )
default

Finalizes the book management settings.

Member Function Documentation

◆ consolidatedBooks() [1/2]

const ConsolidatedBookManagement & consolidatedBooks ( ) const
inlinenoexcept

Returns read-only management settings for consolidated books.

Returns
Consolidated book management settings.

Definition at line 1043 of file BookManagement.h.

◆ consolidatedBooks() [2/2]

ConsolidatedBookManagement & consolidatedBooks ( )
inlinenoexcept

Returns mutable management settings for consolidated books.

Returns
Consolidated book management settings.

Definition at line 1052 of file BookManagement.h.

◆ directBooks() [1/2]

const DirectBookManagement & directBooks ( ) const
inlinenoexcept

Returns read-only management settings for direct books.

Returns
Direct book management settings.

Definition at line 1007 of file BookManagement.h.

◆ directBooks() [2/2]

DirectBookManagement & directBooks ( )
inlinenoexcept

Returns mutable management settings for direct books.

Returns
Direct book management settings.

Definition at line 1016 of file BookManagement.h.

◆ impliedBooks() [1/2]

const ImpliedBookManagement & impliedBooks ( ) const
inlinenoexcept

Returns read-only management settings for implied books.

Returns
Implied book management settings.

Definition at line 1025 of file BookManagement.h.

◆ impliedBooks() [2/2]

ImpliedBookManagement & impliedBooks ( )
inlinenoexcept

Returns mutable management settings for implied books.

Returns
Implied book management settings.

Definition at line 1034 of file BookManagement.h.

◆ mboBooks() [1/2]

const MboBookManagement & mboBooks ( ) const
inlinenoexcept

Returns read-only management settings for MBO books.

Returns
MBO book management settings.

Definition at line 989 of file BookManagement.h.

◆ mboBooks() [2/2]

MboBookManagement & mboBooks ( )
inlinenoexcept

Returns mutable management settings for MBO books.

Returns
MBO book management settings.

Definition at line 998 of file BookManagement.h.

◆ operator=()

BookManagement & operator= ( const BookManagement & other)
inline

Copies book management settings from another instance.

Parameters
otherSource settings.
Returns
Reference to this object.
Note
Assignment-control state is not copied; only setting values are copied.
Exceptions
std::runtime_errorIf the setting belongs to a handler that is processing market data or being configured from another source.

Definition at line 1088 of file BookManagement.h.

◆ updateNotification() [1/2]

BookUpdateNotification::Enum updateNotification ( ) const
inlinenoexcept

Returns the policy used to raise book update callbacks.

Returns
Current book update notification policy.
Note
Default is BookUpdateNotification::OnEndOfEvent.

Definition at line 1062 of file BookManagement.h.

◆ updateNotification() [2/2]

BookManagement & updateNotification ( BookUpdateNotification::Enum value)
inline

Sets the policy used to raise book update callbacks.

Parameters
valueNew notification policy.
Returns
Reference to this object.
Exceptions
std::runtime_errorIf the setting belongs to a handler that is processing market data or being configured from another source.

Definition at line 1073 of file BookManagement.h.

◆ HandlerSettings

friend class HandlerSettings
friend

Definition at line 1098 of file BookManagement.h.