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

Interface for non blocking sending of Notifications More...

#include <INonBlockingNotificationSending.hpp>

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

Public Member Functions

virtual Future< NotificationNameIdTypeNonBlockingRegisterNotification (const String &notificationName, const String &senderName, Severity severity, PayloadTypeIdType payloadTypeId)=0
 Registers a new Notification (non-blocking) More...
 
virtual Future< void > NonBlockingUnregisterNotification (NotificationNameIdType notificationNameId)=0
 Unregisters a Nototification (non-blocking) More...
 
virtual Future< NotificationIdTypeNonBlockingSendNotification (NotificationNameIdType notificationNameId, Arp::DateTime timestamp, const RawPayloadType &payload)=0
 Sends a notification (non-blocking) More...
 
virtual Future< NotificationIdTypeNonBlockingSendNotification (NotificationNameIdType notificationNameId, Arp::DateTime timestamp, const IPayload &payload)=0
 Sends a notification (non-blocking) More...
 

Detailed Description

Interface for non blocking sending of Notifications

All function of this interface are executed asynchronously and returns a Future to access the return value.

Member Function Documentation

◆ NonBlockingRegisterNotification()

virtual Future<NotificationNameIdType> Arp::System::Nm::INonBlockingNotificationSending::NonBlockingRegisterNotification ( const String notificationName,
const String senderName,
Severity  severity,
PayloadTypeIdType  payloadTypeId 
)
pure virtual

Registers a new Notification (non-blocking)

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 (Future), necessary for sending and unregistering

Implemented in Arp::System::Nm::NotificationManager, and Arp::System::Nm::NonBlockingNotificationSendingAdapter.

◆ NonBlockingSendNotification() [1/2]

virtual Future<NotificationIdType> Arp::System::Nm::INonBlockingNotificationSending::NonBlockingSendNotification ( NotificationNameIdType  notificationNameId,
Arp::DateTime  timestamp,
const IPayload payload 
)
pure virtual

Sends a notification (non-blocking)

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

Implemented in Arp::System::Nm::NotificationManager, and Arp::System::Nm::NonBlockingNotificationSendingAdapter.

◆ NonBlockingSendNotification() [2/2]

virtual Future<NotificationIdType> Arp::System::Nm::INonBlockingNotificationSending::NonBlockingSendNotification ( NotificationNameIdType  notificationNameId,
Arp::DateTime  timestamp,
const RawPayloadType payload 
)
pure virtual

Sends a notification (non-blocking)

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

Implemented in Arp::System::Nm::NotificationManager, and Arp::System::Nm::NonBlockingNotificationSendingAdapter.

◆ NonBlockingUnregisterNotification()

virtual Future<void> Arp::System::Nm::INonBlockingNotificationSending::NonBlockingUnregisterNotification ( NotificationNameIdType  notificationNameId)
pure virtual

Unregisters a Nototification (non-blocking)

Parameters
notificationNameIdid of the NotificationName to unregister
Returns
Future to check for exceptions or completion

Implemented in Arp::System::Nm::NotificationManager, and Arp::System::Nm::NonBlockingNotificationSendingAdapter.


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