NotificationManager.hpp

 
//
//  Copyright PHOENIX CONTACT Electronics GmbH
//
 
#pragma once
 
#include "Arp/System/Core/AppDomainSingleton.hxx"
#include "Arp/System/Commons/Logging.h"
 
#include "Arp/System/Nm/INonBlockingNotificationSending.hpp"
#include "Arp/System/Nm/INotificationManagerInfo.hpp"
#include "Arp/System/Nm/INotificationReceiving.hpp"
#include "Arp/System/Nm/INotificationSending.hpp"
#include "Arp/System/Nm/NonBlockingNotificationRegistration.hpp"
#include "Arp/System/Nm/NonBlockingNotificationRegistration3.hpp"
#include "Arp/System/Nm/NonBlockingNotificationSendingAdapter.hpp"
#include "Arp/System/Nm/NotificationRegistration.hpp"
#include "Arp/System/Nm/NotificationSubscriber.hpp"
 
namespace Arp { namespace System { namespace Nm
{
 
class NotificationManager
    : public AppDomainSingleton<NotificationManager>
    , public INotificationSending
    , public INonBlockingNotificationSending
    , public INotificationManagerInfo
    , public INotificationReceiving
    , private Loggable<NotificationManager, true>
{
    friend class AppDomainSingleton<NotificationManager>;
    friend class NonBlockingNotificationSendingAdapter;
 
private:
    class Impl;
 
protected:
    explicit NotificationManager(size_t nonBlockingNotificationSendingProxyQueueLength = 128);
    ~NotificationManager() override;
 
public:
    NotificationManager(const NotificationManager&) = delete;
    NotificationManager(NotificationManager&&) = delete;
 
    NotificationManager& operator=(const NotificationManager&) = delete;
    NotificationManager& operator=(NotificationManager&&) = delete;
 
    // High level operations using proxy objects
    template<typename PayloadType>
    NotificationRegistration<PayloadType> CreateNotificationRegistration(
        const String& notificationName, const String& senderName, Severity severity);
 
    template<typename PayloadType>
    NonBlockingNotificationRegistration<PayloadType> CreateNonBlockingNotificationRegistration(
        const String& notificationName, const String& senderName, Severity severity);
 
    template<typename PayloadType>
    NonBlockingNotificationRegistration<PayloadType> CreateNonBlockingNotificationRegistration2(
        const String& notificationName, const String& senderName, Severity severity);
 
    template<typename PayloadType, typename ArgumentsType = typename PayloadType::ArgumentsType>
    NonBlockingNotificationRegistration3<PayloadType, ArgumentsType> CreateNonBlockingNotificationRegistration3(
        const String& notificationName, const String& senderName, Severity severity,
        size_t argumentsBufferCapacity = GetDefaultArgumentsBufferCapacity());
 
    NotificationSubscriber CreateNotificationSubscriber(const String& notificationName);
 
    // Methods of INotificationSending
    NotificationNameIdType RegisterNotification(const String& notificationName, const String& senderName,
            Severity severity, PayloadTypeIdType payloadTypeId) override;
    void UnregisterNotification(NotificationNameIdType notificationNameId) override;
 
    NotificationIdType SendNotification(
        NotificationNameIdType notificationNameId, Arp::DateTime timestamp, const RawPayloadType& payload) override;
    NotificationIdType SendNotification(
        NotificationNameIdType notificationNameId, Arp::DateTime timestamp, const IPayload& payload) override;
 
    // Methods of INonBlockingNotificationSending
    Future<NotificationNameIdType> NonBlockingRegisterNotification(const String& notificationName,
            const String& senderName, Severity severity, PayloadTypeIdType payloadTypeId) override;
 
    void NonBlockingRegisterNotification(const String& notificationName, const String& senderName, Severity severity,
                                         PayloadTypeIdType payloadTypeId, Future<NotificationNameIdType> result);
 
    Future<void> NonBlockingUnregisterNotification(NotificationNameIdType notificationNameId) override;
 
    void NonBlockingUnregisterNotification(NotificationNameIdType notificationNameId, Future<void> result);
 
    Future<NotificationIdType> NonBlockingSendNotification(
        NotificationNameIdType notificationNameId, Arp::DateTime timestamp, const RawPayloadType& payload) override;
 
    void NonBlockingSendNotification(NotificationNameIdType notificationNameId, Arp::DateTime timestamp,
                                     std::function<RawPayloadType()> createPayloadFunctor, Future<NotificationIdType> result);
 
    Future<NotificationIdType> NonBlockingSendNotification(
        NotificationNameIdType notificationNameId, Arp::DateTime timestamp, const IPayload& payload) override;
 
private:
    void NonBlockingSendNotification(NotificationNameIdType notificationNameId, Arp::DateTime timestamp,
                                     NonBlockingNotificationSendingAdapter::CreatePayloadFunctor createPayloadFunctor,
                                     NonBlockingNotificationSendingAdapter::CreatePayloadFunctorArg createPayloadFunctorArg,
                                     Future<NotificationIdType> result);
 
    static size_t GetDefaultArgumentsBufferCapacity();
 
public:
    // Methods of INotificationManagerInfo
    const String GetNotificationName(NotificationNameIdType notificationNameId) const override;
    const NotificationNameIdType GetNotificationNameId(const String& notificationName) override;
 
    const NotificationNameIdList GetNotificationNameIdsByStatus(
        const NotificationRegistrationStatus& status) const override;
    const NotificationNameIdList GetAllKnownNotificationNameIds() const override;
    const NotificationRegistrationInfo GetNotificationRegistration(
        NotificationNameIdType notificationNameId) const override;
 
    const PayloadTypeIdType GetPayloadTypeId(const String& payloadTypeName) override;
    const String GetPayloadTypeName(const PayloadTypeIdType& payloadTypeId) const override;
 
    Arp::uint64 GetNumberOfSubmittedNotifications() const override;
 
    // Methods of INotificationReceiving
    NotificationNameIdType Subscribe(const String& notificationName, INotificationSubscriber* subscriber) override;
    void Unsubscribe(NotificationNameIdType notificationNameId, INotificationSubscriber* subscriber) override;
    void UnsubscribeFromAll(INotificationSubscriber* subscriber) override;
 
    void ReplaceSubscriber(INotificationSubscriber* oldSubscriber, INotificationSubscriber* newSubscriber);
 
private:
    const std::unique_ptr<Impl> pImpl;
};
 
template<typename PayloadType>
NotificationRegistration<PayloadType> NotificationManager::CreateNotificationRegistration(
    const String& notificationName, const String& senderName, Severity severity)
{
    return NotificationRegistration<PayloadType>(notificationName, senderName, severity, *(this));
}
 
template<typename PayloadType>
NonBlockingNotificationRegistration<PayloadType> NotificationManager::CreateNonBlockingNotificationRegistration(
    const String& notificationName, const String& senderName, Severity severity)
{
    return NonBlockingNotificationRegistration<PayloadType>(notificationName, senderName, severity, *this);
}
 
template<typename PayloadType>
NonBlockingNotificationRegistration<PayloadType> NotificationManager::CreateNonBlockingNotificationRegistration2(
    const String& notificationName, const String& senderName, Severity severity)
{
    return NonBlockingNotificationRegistration<PayloadType>(
               notificationName, senderName, severity, new NonBlockingNotificationSendingAdapter(*this));
}
 
template<typename PayloadType, typename ArgumentsType>
NonBlockingNotificationRegistration3<PayloadType, ArgumentsType>
NotificationManager::CreateNonBlockingNotificationRegistration3(
    const String& notificationName, const String& senderName, Severity severity, size_t argumentsBufferCapacity)
{
    return NonBlockingNotificationRegistration3<PayloadType, ArgumentsType>(notificationName, senderName, severity,
            argumentsBufferCapacity, std::make_unique<NonBlockingNotificationSendingAdapter>(*this));
}
 
}}} // end of namespace Arp::System::Nm