PLCnext API Documentation 25.0.2.69
INotificationLoggerService2.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6#pragma once
8#include "Arp/Base/Rsc/Commons/Rsc.hpp"
9#include "Arp/Base/Rsc/Commons/IRscService.hpp"
10#include "Arp/Base/Rsc/Commons/IRscReadEnumerator.hxx"
11#include "Arp/Base/Rsc/Commons/IRscWriteEnumerator.hxx"
12#include "Arp/Base/Core/delegate.hxx"
13#include <vector>
14#include "Arp/Base/Rsc/Commons/RscString.hxx"
15#include "Arp/Services/NotificationLogger/Services/NotificationFilter2.hpp"
16#include "Arp/Services/NotificationLogger/Services/SortOrder.hpp"
17#include "Arp/Services/NotificationLogger/Services/StoredNotification2.hpp"
18
19// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY INotificationLoggerService2.cs
20
22{
23
24using namespace Arp::Base::Rsc::Commons;
25
34{
35public: // usings
36 using Ptr = std::shared_ptr<INotificationLoggerService2>;
38
39public: // construction/destruction
42
43public: // static policy operation
44 static IRscServiceProxyFactory& GetProxyFactory(void);
45
46public: // abstract operations
57 virtual void ReadStoredNotifications(const std::vector<RscString<64>>& archives, const NotificationFilter2& filter, int32 limit, SortOrder sortOrder, boolean includePayloadXml, ReadStoredNotificationsResultDelegate resultDelegate) = 0;
58
65 virtual int32 DeleteNotifications(const std::vector<RscString<64>>& archives, const NotificationFilter2& filter) = 0;
66
72 virtual std::vector<RscString<64>> GetArchiveNames() = 0;
73};
74
75} // end of namespace Arp::Services::NotificationLogger::Services
Prototyping of delegate template.
Definition: delegate.hxx:14
Interface for reading a arrays or enumerations.
Definition: IRscReadEnumerator.hxx:19
This is the base interface of all Rsc services.
Definition: IRscService.hpp:22
std::shared_ptr< IRscService > Ptr
The shared_ptr type of IRscService.
Definition: IRscService.hpp:25
Contains a static string with string lentgh up to N characters. The string shall be null terminated.
Definition: RscString.hxx:24
Interface for service proxy factories to create service proxies used by RSC clients.
Definition: IRscServiceProxyFactory.hpp:22
The NotificationLogger stores Notifications and provides an interface to retrieve them.
Definition: INotificationLoggerService2.hpp:34
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:27
std::int32_t int32
The Arp integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:35
Namespace for services of the NotificationLogger
SortOrder
Definition how to sort the queried notifications
Definition: SortOrder.hpp:19