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

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

Public Member Functions

virtual void beginChange (const SettingGroup &group, const Messaging::Char *details)=0
virtual void endChange ()=0

Detailed Description

A controller may reject a change in beginChange(). After beginChange() succeeds, the caller must invoke endChange() exactly once.

Definition at line 37 of file SettingGroup.h.

Member Function Documentation

◆ beginChange()

virtual void beginChange ( const SettingGroup & group,
const Messaging::Char * details )
pure virtual

Starts a guarded setting change.

Parameters
groupGroup containing the setting being changed.
detailsHuman-readable description of the change; may be null.
Exceptions
Anyexception used by the implementation to reject or defer the change.

Implemented in TrivialChangeController.

◆ endChange()

virtual void endChange ( )
pure virtual

Completes the current guarded setting change.

Note
Call this exactly once after a successful beginChange() and before starting another change through the same controller.
Implementations must not throw. This function is called from the noexcept SettingChangeGuard destructor; an escaping exception terminates the process.

Implemented in TrivialChangeController.