10#include "Arp/System/Core/AppDomainSingleton.hxx"
11#include "Arp/System/Commons/Logging.h"
13#include "Arp/System/Nm/INonBlockingNotificationSending.hpp"
14#include "Arp/System/Nm/INotificationManagerInfo.hpp"
15#include "Arp/System/Nm/INotificationReceiving.hpp"
16#include "Arp/System/Nm/INotificationSending.hpp"
17#include "Arp/System/Nm/NonBlockingNotificationRegistration.hpp"
18#include "Arp/System/Nm/NonBlockingNotificationRegistration3.hpp"
19#include "Arp/System/Nm/NonBlockingNotificationSendingAdapter.hpp"
20#include "Arp/System/Nm/NotificationRegistration.hpp"
21#include "Arp/System/Nm/NotificationSubscriber.hpp"
23namespace Arp {
namespace System {
namespace Nm
49 ,
private Loggable<NotificationManager, true>
76 template<
typename PayloadType>
91 template<
typename PayloadType>
110 template<
typename PayloadType>
125 template<
typename PayloadType,
typename ArgumentsType =
typename PayloadType::ArgumentsType>
128 size_t argumentsBufferCapacity = GetDefaultArgumentsBufferCapacity());
148 void NonBlockingRegisterNotification(
const String& notificationName,
const String& senderName,
Severity severity,
166 NonBlockingNotificationSendingAdapter::CreatePayloadFunctor createPayloadFunctor,
170 static size_t GetDefaultArgumentsBufferCapacity();
196 const std::unique_ptr<Impl> pImpl;
199template<
typename PayloadType>
206template<
typename PayloadType>
213template<
typename PayloadType>
221template<
typename PayloadType,
typename ArgumentsType>
224 const String& notificationName,
const String& senderName,
Severity severity,
size_t argumentsBufferCapacity)
227 argumentsBufferCapacity, std::make_unique<NonBlockingNotificationSendingAdapter>(*
this));
This class implements the singleton pattern for singletons with process wide scope.
Definition: AppDomainSingleton.hxx:25
The class contains date and time informations.
Definition: DateTime.hpp:46
Definition: Loggable.hxx:20
Future object as proxy for return value an asynchronous function call
Definition: Future.hpp:192
Future object as proxy for return value an asynchronous function call
Definition: Future.hpp:115
Interface for non blocking sending of Notifications
Definition: INonBlockingNotificationSending.hpp:23
Interface for information about the Notification Manager
Definition: INotificationManagerInfo.hpp:22
Interface for subscribers of Notifications
Definition: INotificationReceiving.hpp:20
Interface for sending of notifications
Definition: INotificationSending.hpp:21
Interface for subscribers of Notifications
Definition: INotificationSubscriber.hpp:21
Interface for Paylo objects
Definition: IPayload.hpp:19
Proxy object for a non-blocking NotificationRegistration
Definition: NonBlockingNotificationRegistration3.hpp:54
Proxy object for a non-blocking NotificationRegistration
Definition: NonBlockingNotificationRegistration.hpp:35
Adapter for INonBlockingNotificationSending with additional functions
Definition: NonBlockingNotificationSendingAdapter.hpp:26
Primary access to the NotificationManager
Definition: NotificationManager.hpp:50
const String GetNotificationName(NotificationNameIdType notificationNameId) const override
Queries the NotifictionName
NonBlockingNotificationRegistration< PayloadType > CreateNonBlockingNotificationRegistration2(const String ¬ificationName, const String &senderName, Severity severity)
Creates a NonBlockingNotificationRegistration proxy
Definition: NotificationManager.hpp:214
NotificationSubscriber CreateNotificationSubscriber(const String ¬ificationName)
Creates a NotificationSubscriber proxy
NotificationNameIdType Subscribe(const String ¬ificationName, INotificationSubscriber *subscriber) override
Subscribe to a Notification
Future< NotificationIdType > NonBlockingSendNotification(NotificationNameIdType notificationNameId, Arp::DateTime timestamp, const IPayload &payload) override
Sends a notification (non-blocking)
Future< NotificationNameIdType > NonBlockingRegisterNotification(const String ¬ificationName, const String &senderName, Severity severity, PayloadTypeIdType payloadTypeId) override
Registers a new Notification (non-blocking)
NotificationRegistration< PayloadType > CreateNotificationRegistration(const String ¬ificationName, const String &senderName, Severity severity)
Creates a NotificationRegistration proxy
Definition: NotificationManager.hpp:200
Future< NotificationIdType > NonBlockingSendNotification(NotificationNameIdType notificationNameId, Arp::DateTime timestamp, const RawPayloadType &payload) override
Sends a notification (non-blocking)
void UnregisterNotification(NotificationNameIdType notificationNameId) override
Unregisters a Nototification
const PayloadTypeIdType GetPayloadTypeId(const String &payloadTypeName) override
Query an id for a given PayloadType
const String GetPayloadTypeName(const PayloadTypeIdType &payloadTypeId) const override
Query the payload type name of a given id
const NotificationRegistrationInfo GetNotificationRegistration(NotificationNameIdType notificationNameId) const override
Queries information about an Notification
Future< void > NonBlockingUnregisterNotification(NotificationNameIdType notificationNameId) override
Unregisters a Nototification (non-blocking)
const NotificationNameIdList GetAllKnownNotificationNameIds() const override
Queries of all known NotificationNameIds
const NotificationNameIdList GetNotificationNameIdsByStatus(const NotificationRegistrationStatus &status) const override
Queries the ids of Notifications with a given NotificationRegistrationStatus
const NotificationNameIdType GetNotificationNameId(const String ¬ificationName) override
Queries the id of an NotificationName
void Unsubscribe(NotificationNameIdType notificationNameId, INotificationSubscriber *subscriber) override
Unsubscribe from a Notification
NonBlockingNotificationRegistration< PayloadType > CreateNonBlockingNotificationRegistration(const String ¬ificationName, const String &senderName, Severity severity)
Creates a NonBlockingNotificationRegistration proxy
Definition: NotificationManager.hpp:207
NotificationIdType SendNotification(NotificationNameIdType notificationNameId, Arp::DateTime timestamp, const RawPayloadType &payload) override
Sends a notification
Arp::uint64 GetNumberOfSubmittedNotifications() const override
Returns the number of Notifications submitted since startup of the controller
NonBlockingNotificationRegistration3< PayloadType, ArgumentsType > CreateNonBlockingNotificationRegistration3(const String ¬ificationName, const String &senderName, Severity severity, size_t argumentsBufferCapacity=GetDefaultArgumentsBufferCapacity())
Creates a NonBlockingNotificationRegistration3 proxy
Definition: NotificationManager.hpp:223
NotificationNameIdType RegisterNotification(const String ¬ificationName, const String &senderName, Severity severity, PayloadTypeIdType payloadTypeId) override
Registers a new Notification
NotificationIdType SendNotification(NotificationNameIdType notificationNameId, Arp::DateTime timestamp, const IPayload &payload) override
Sends a notification
void UnsubscribeFromAll(INotificationSubscriber *subscriber) override
Unsubscribe from all Notification
Information about the registration of a Notification
Definition: NotificationRegistrationInfo.hpp:22
Proxy object for a NotificationRegistration
Definition: NotificationRegistration.hpp:32
Proxy class for an subscriber of notifications
Definition: NotificationSubscriber.hpp:31
std::uint64_t uint64
The Arp unsigned integer type of 8 byte size.
Definition: PrimitiveTypes.hpp:40
@ System
System components used by the System, Device, Plc or Io domains.
enum ARP_CXX_SYMBOL_EXPORT Severity
Enumeration of Severities for notifications
Definition: Severity.hpp:14
enum ARP_CXX_SYMBOL_EXPORT NotificationRegistrationStatus
Enumeration to represent the status of the Notification
Definition: NotificationRegistrationStatus.hpp:14
std::vector< NotificationNameIdType > NotificationNameIdList
collection of Notification name ids
Definition: NotificationManagerTypes.hpp:25
std::vector< Arp::System::Rsc::Services::RscVariant< RawPayloadTypeLength > > RawPayloadType
type for the internally transferred payloads
Definition: NotificationManagerTypes.hpp:34
Root namespace for the PLCnext API
Definition: NonBlockingNotificationSendingAdapter.hpp:29