PLCnext API Documentation 23.6.0.37
INotificationLoggerService2.hpp
1
2//
3// Copyright PHOENIX CONTACT Electronics GmbH
4//
6#pragma once
8#include <vector>
9#include "Arp/Services/NotificationLogger/Services/NotificationFilter2.hpp"
10#include "Arp/Services/NotificationLogger/Services/NotificationLoggerService2ProxyFactory.hpp"
11#include "Arp/Services/NotificationLogger/Services/SortOrder.hpp"
12#include "Arp/Services/NotificationLogger/Services/StoredNotification2.hpp"
13#include "Arp/System/Core/delegate.hxx"
14#include "Arp/System/Rsc/Services/IRscReadEnumerator.hxx"
15#include "Arp/System/Rsc/Services/IRscService.hpp"
16#include "Arp/System/Rsc/Services/IRscWriteEnumerator.hxx"
17#include "Arp/System/Rsc/Services/RscString.hxx"
18
19// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY INotificationLoggerService2.cs
20
21namespace Arp { namespace Services { namespace NotificationLogger { namespace Services
22{
23
24using namespace Arp;
25using namespace Arp::System::Rsc::Services;
26
35{
36public: // typedefs
37 using Ptr = std::shared_ptr<INotificationLoggerService2>;
38 using ReadStoredNotificationsResultDelegate = delegate<void(IRscReadEnumerator<StoredNotification2>&)>;
39
40public: // construction/destruction
43
44public: // static policy operation
45 static IRscServiceProxyFactory& GetProxyFactory(void);
46
47public: // abstract operations
58 virtual void ReadStoredNotifications(const std::vector<RscString<64>>& archives, const NotificationFilter2& filter, int32 limit, SortOrder sortOrder, boolean includePayloadXml, ReadStoredNotificationsResultDelegate resultDelegate) = 0;
59
66 virtual int32 DeleteNotifications(const std::vector<RscString<64>>& archives, const NotificationFilter2& filter) = 0;
67
73 virtual std::vector<RscString<64>> GetArchiveNames() = 0;
74};
75
77// inline methods of class INotificationLoggerService2
78inline IRscServiceProxyFactory& INotificationLoggerService2::GetProxyFactory()
79{
80 return NotificationLoggerService2ProxyFactory::GetInstance();
81}
82
83}}}} // end of namespace Arp::Services::NotificationLogger::Services
The NotificationLogger stores Notifications and provides an interface to retrieve them.
Definition: INotificationLoggerService2.hpp:35
INotificationLoggerService2(void)=default
Constructs an INotificationLoggerService2 instance.
virtual void ReadStoredNotifications(const std::vector< RscString< 64 > > &archives, const NotificationFilter2 &filter, int32 limit, SortOrder sortOrder, boolean includePayloadXml, ReadStoredNotificationsResultDelegate resultDelegate)=0
Queries notifications matching the supplied filter from the mentioned archives and returns them as St...
virtual std::vector< RscString< 64 > > GetArchiveNames()=0
Queries a list of archives
virtual int32 DeleteNotifications(const std::vector< RscString< 64 > > &archives, const NotificationFilter2 &filter)=0
Remove notifications mathing the filter from the given archives
Filter specification to match notification on query or delete
Definition: NotificationFilter2.hpp:25
Interface for reading an array or an enumerator. For regular enumerators UndefinedArrayLength is used...
Definition: IRscReadEnumerator.hxx:21
Base interface for all Rsc service interface.
Definition: IRscService.hpp:20
Contains a static string with string lentgh up to N characters. The string has to be null terminated.
Definition: RscString.hxx:21
std::int32_t int32
The Arp integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:38
SortOrder
Definition how to sort the queried notifications
Definition: SortOrder.hpp:19
Namespace for classes and interfaces for the Remote Service Call implementation
Root namespace for the PLCnext API