Cpl::Dm::NotificationApi_ Class Reference

This class has PACKAGE Scope, i.e. More...

Detailed Description

This class has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::Dm namespace. The Application should NEVER call this method.

This class defines the interface to register for Model Point Change notifications.

#include <NotificationApi_.h>

Inheritance diagram for Cpl::Dm::NotificationApi_:

Public Member Functions
virtual void	addPendingChangingNotification_ (SubscriberApi &subscriber) noexcept=0
	This method has PACKAGE Scope, i.e.
virtual void	removePendingChangingNotification_ (SubscriberApi &subscriber) noexcept=0
	This method has PACKAGE Scope, i.e.
virtual	~NotificationApi_ ()
	Virtual destructor.

Constructor & Destructor Documentation

~NotificationApi_()

virtual Cpl::Dm::NotificationApi_::~NotificationApi_ ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

addPendingChangingNotification_()

virtual void Cpl::Dm::NotificationApi_::addPendingChangingNotification_ ( SubscriberApi &  subscriber )

pure virtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::Dm namespace. The Application should NEVER call this method.

This method is used add a new 'change notification' to its list of pending change notifications. Calling this method when the subscriber is already registered for change notification will cause a FATAL ERROR.

This method IS thread safe.

NOTE: The requirements and/or semantics of Model Point subscription is that Subscriptions, Notifications, and Cancel-of-Subscriptions all happen in a SINGLE thread and that thread is the 'Subscribers' thread.

Implemented in Cpl::Dm::EventLoop.

removePendingChangingNotification_()

virtual void Cpl::Dm::NotificationApi_::removePendingChangingNotification_ ( SubscriberApi &  subscriber )

pure virtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::Dm namespace. The Application should NEVER call this method.

This method is used remove a pending 'change notification' from its list of pending change notifications. It is okay to call this method even if the Subscriber is not current registered for change notifications.

This method IS thread safe.

NOTE: The requirements and/or semantics of Model Point subscription is that Subscriptions, Notifications, and Cancel-of-Subscriptions all happen in a SINGLE thread and that thread is the 'Subscribers' thread.

Implemented in Cpl::Dm::EventLoop.

---

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

• Cpl/Dm/NotificationApi_.h