ALib C++ Library
Library Version: 2412 R0
Documentation generated by doxygen
Loading...
Searching...
No Matches
ConfigurationListener Struct Referenceabstract

Description:

Abstract virtual interface type to implement types observing configuration changes.

See also
Chapter 9. Monitoring Changes of Variables of the Programmer's Manual of camp ALib Configuration.

Definition at line 126 of file configuration.hpp.

#include <configuration.hpp>

Public Type Index:

enum class  Event { Creation , Definition , Deletion }
 The type of change that imposes the notification of a listener. More...
 

Public Method Index:

virtual ~ConfigurationListener ()
 Virtual destructor.
 
virtual void Notify (const Variable &variable, Event event, Priority previousPriority)=0
 

Enumeration Details:

◆ Event

enum class Event
strong

The type of change that imposes the notification of a listener.

Enumerator
Creation 

A variable was declared for the first time.

Definition 

A variable was defined or re-defined with the same or a higher priority.

Deletion 

A variable is deleted. Note that the variable is still valid when method Notify is invoked and will be deleted right after the invocation of all listeners in question.

Definition at line 129 of file configuration.hpp.

Constructor(s) / Destructor Details:

◆ ~ConfigurationListener()

virtual ~ConfigurationListener ( )
inlinevirtual

Virtual destructor.

Definition at line 139 of file configuration.hpp.

Method Details:

◆ Notify()

virtual void Notify ( const Variable & variable,
Event event,
Priority previousPriority )
pure virtual

The virtual notification method.

Parameters
variableThe variable that was modified.
eventThe type of modification.
previousPriorityThe priority of the variable before event type Event::Definition.

With other events, this parameter is undefined.


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