PLCnext API Documentation 25.0.2.69
INotificationSending.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6
7#pragma once
8
10#include "Arp/System/Nm/IPayload.hpp"
11#include "Arp/System/Nm/NotificationManagerTypes.hpp"
12#include "Arp/System/Nm/Severity.hpp"
13
14
15namespace Arp { namespace System { namespace Nm
16{
17
18
20class ARP_CXX_SYMBOL_EXPORT INotificationSending
21{
22public:
23 virtual ~INotificationSending() = default;
24
32 virtual NotificationNameIdType RegisterNotification(const String& notificationName,
33 const String& senderName, Severity severity, PayloadTypeIdType payloadTypeId) = 0;
34
37 virtual void UnregisterNotification(NotificationNameIdType notificationNameId) = 0;
38
45 Arp::DateTime timestamp, const RawPayloadType& payload) = 0;
46
53 Arp::DateTime timestamp, const IPayload& payload) = 0;
54};
55
56
57}}} // end of namespace Arp::System::Nm
This class contains date and time informations.
Definition: DateTime.hpp:27
This class represents the Arp String. The implementation is based on std::string.
Definition: String.hpp:39
Interface for sending of notifications
Definition: INotificationSending.hpp:21
virtual NotificationIdType SendNotification(NotificationNameIdType notificationNameId, Arp::DateTime timestamp, const IPayload &payload)=0
Sends a notification
virtual void UnregisterNotification(NotificationNameIdType notificationNameId)=0
Unregisters a Nototification
virtual NotificationIdType SendNotification(NotificationNameIdType notificationNameId, Arp::DateTime timestamp, const RawPayloadType &payload)=0
Sends a notification
virtual NotificationNameIdType RegisterNotification(const String &notificationName, const String &senderName, Severity severity, PayloadTypeIdType payloadTypeId)=0
Registers a new Notification
Interface for Paylo objects
Definition: IPayload.hpp:19
enum ARP_CXX_SYMBOL_EXPORT Severity
Enumeration of Severities for notifications
Definition: Severity.hpp:14
std::vector< Arp::Base::Rsc::Commons::RscVariant< RawPayloadTypeLength > > RawPayloadType
type for the internally transferred payloads
Definition: NotificationManagerTypes.hpp:32
Root namespace for the PLCnext API