PLCnext API Documentation 25.0.2.69
INetloadLimiterStatisticService.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 <vector>
11#include "Arp/Hardware/Nim/Services/NetloadLimiterErrorCode.hpp"
12#include "Arp/Hardware/Nim/Services/NetloadLimiterStatisticResult.hpp"
13
14// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY INetloadLimiterStatisticService.cs
15
17{
18
19using namespace Arp::Base::Rsc::Commons;
20
27{
28public: // usings
29 using Ptr = std::shared_ptr<INetloadLimiterStatisticService>;
30
31public: // construction/destruction
34
35public: // static policy operation
36 static IRscServiceProxyFactory& GetProxyFactory(void);
37
38public: // abstract operations
44 virtual NetloadLimiterStatisticResult GetStatistic(uint8 networkInterfaceId) = 0;
45
51 virtual std::vector<NetloadLimiterStatisticResult> GetStatistics(const std::vector<uint8>& networkInterfaceIds) = 0;
52
58 virtual NetloadLimiterErrorCode ResetStatistic(uint8 networkInterfaceId) = 0;
59};
60
61} // end of namespace Arp::Hardware::Nim::Services
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
Interface for service proxy factories to create service proxies used by RSC clients.
Definition: IRscServiceProxyFactory.hpp:22
Service for the netload limiter statistic handling
Definition: INetloadLimiterStatisticService.hpp:27
virtual NetloadLimiterErrorCode ResetStatistic(uint8 networkInterfaceId)=0
Reset the statistic values Max, Peak and Duration of the packet and byte statistics for the specified...
virtual NetloadLimiterStatisticResult GetStatistic(uint8 networkInterfaceId)=0
Read the statistic values of die specified network interface
virtual std::vector< NetloadLimiterStatisticResult > GetStatistics(const std::vector< uint8 > &networkInterfaceIds)=0
Read the statistic values of die specified network interfaces
INetloadLimiterStatisticService(void)=default
Constructs an INetloadLimiterStatisticService instance.
Result for reading the NetloadLimiter statistics.
Definition: NetloadLimiterStatisticResult.hpp:28
std::uint8_t uint8
The Arp unsigned integer type of 1 byte size.
Definition: PrimitiveTypes.hpp:25
Namespace for services of the Network Interface Manager
NetloadLimiterErrorCode
This enum contains the error codes for the operations of the netload limiter services.
Definition: NetloadLimiterErrorCode.hpp:19