PLCnext API Documentation 25.0.2.69
Public Member Functions | List of all members
Arp::System::Nm::INotificationReceiving Class Referenceabstract

Interface for subscribers of Notifications More...

#include <INotificationReceiving.hpp>

Inheritance diagram for Arp::System::Nm::INotificationReceiving:
Inheritance graph

Public Member Functions

virtual NotificationNameIdType Subscribe (const String &notificationName, INotificationSubscriber *subscriber)=0
 Subscribe to a Notification More...
 
virtual void Unsubscribe (NotificationNameIdType notificationNameId, INotificationSubscriber *subscriber)=0
 Unsubscribe from a Notification More...
 
virtual void UnsubscribeFromAll (INotificationSubscriber *subscriber)=0
 Unsubscribe from all Notification More...
 

Detailed Description

Interface for subscribers of Notifications

Member Function Documentation

◆ Subscribe()

virtual NotificationNameIdType Arp::System::Nm::INotificationReceiving::Subscribe ( const String notificationName,
INotificationSubscriber subscriber 
)
pure virtual

Subscribe to a Notification

Parameters
notificationNameName of the Notification to subscribe to
subscriberPointer to the ISubscriber (!= nullptr)

Implemented in Arp::System::Nm::NotificationManager.

◆ Unsubscribe()

virtual void Arp::System::Nm::INotificationReceiving::Unsubscribe ( NotificationNameIdType  notificationNameId,
INotificationSubscriber subscriber 
)
pure virtual

Unsubscribe from a Notification

Parameters
notificationNameName of the Notification to unsubscribe from
subscriberPointer to the ISubscriber (!= nullptr)

Implemented in Arp::System::Nm::NotificationManager.

◆ UnsubscribeFromAll()

virtual void Arp::System::Nm::INotificationReceiving::UnsubscribeFromAll ( INotificationSubscriber subscriber)
pure virtual

Unsubscribe from all Notification

Parameters
subscriberPointer to the ISubscriber (!= nullptr)

This function should be called before Subscriber is destructed!

Implemented in Arp::System::Nm::NotificationManager.


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