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

Interface for sending of notifications More...

#include <INotificationSending.hpp>

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

Public Member Functions

virtual NotificationNameIdType RegisterNotification (const String &notificationName, const String &senderName, Severity severity, PayloadTypeIdType payloadTypeId)=0
 Registers a new Notification More...
 
virtual void UnregisterNotification (NotificationNameIdType notificationNameId)=0
 Unregisters a Nototification More...
 
virtual NotificationIdType SendNotification (NotificationNameIdType notificationNameId, Arp::DateTime timestamp, const RawPayloadType &payload)=0
 Sends a notification More...
 
virtual NotificationIdType SendNotification (NotificationNameIdType notificationNameId, Arp::DateTime timestamp, const IPayload &payload)=0
 Sends a notification More...
 

Detailed Description

Interface for sending of notifications

Member Function Documentation

◆ RegisterNotification()

virtual NotificationNameIdType Arp::System::Nm::INotificationSending::RegisterNotification ( const String notificationName,
const String senderName,
Severity  severity,
PayloadTypeIdType  payloadTypeId 
)
pure virtual

Registers a new Notification

Parameters
notificationNamename of the notification (e.g. Arp.System.Nm.SomethingInterestingHappened)
senderNamename of the sender of the notification
severityseverity of the notification
payloadTypeIdid of the payload type
Returns
NotificationNameId, necessary for sending and unregistering

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

◆ SendNotification() [1/2]

virtual NotificationIdType Arp::System::Nm::INotificationSending::SendNotification ( NotificationNameIdType  notificationNameId,
Arp::DateTime  timestamp,
const IPayload payload 
)
pure virtual

Sends a notification

Parameters
notificationNameIdid of the NotificationName to send
timestampCurrent timestamp
payloadpayload to send
Returns
NotificationId

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

◆ SendNotification() [2/2]

virtual NotificationIdType Arp::System::Nm::INotificationSending::SendNotification ( NotificationNameIdType  notificationNameId,
Arp::DateTime  timestamp,
const RawPayloadType payload 
)
pure virtual

Sends a notification

Parameters
notificationNameIdid of the NotificationName to send
timestampCurrent timestamp
payloadpayload to send
Returns
NotificationId

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

◆ UnregisterNotification()

virtual void Arp::System::Nm::INotificationSending::UnregisterNotification ( NotificationNameIdType  notificationNameId)
pure virtual

Unregisters a Nototification

Parameters
notificationNameIdid of the NotificationName to unregister

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


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