PLCnext API Documentation 23.3.0.32
INetloadLimiterStatisticService.hpp
1
2//
3// Copyright PHOENIX CONTACT Electronics GmbH
4//
6#pragma once
8#include <vector>
9#include "Arp/Hardware/Nim/Services/NetloadLimiterErrorCode.hpp"
10#include "Arp/Hardware/Nim/Services/NetloadLimiterStatisticResult.hpp"
11#include "Arp/Hardware/Nim/Services/NetloadLimiterStatisticServiceProxyFactory.hpp"
12#include "Arp/System/Rsc/Services/IRscService.hpp"
13
14// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY INetloadLimiterStatisticService.cs
15
16namespace Arp { namespace Hardware { namespace Nim { namespace Services
17{
18
19using namespace Arp;
20using namespace Arp::System::Rsc::Services;
21
25{
26public: // typedefs
27 using Ptr = std::shared_ptr<INetloadLimiterStatisticService>;
28
29public: // construction/destruction
32
33public: // static policy operation
34 static IRscServiceProxyFactory& GetProxyFactory(void);
35
36public: // abstract operations
42 virtual NetloadLimiterStatisticResult GetStatistic(uint8 networkInterfaceId) = 0;
43
49 virtual std::vector<NetloadLimiterStatisticResult> GetStatistics(const std::vector<uint8>& networkInterfaceIds) = 0;
50
56 virtual NetloadLimiterErrorCode ResetStatistic(uint8 networkInterfaceId) = 0;
57};
58
60// inline methods of class INetloadLimiterStatisticService
61inline IRscServiceProxyFactory& INetloadLimiterStatisticService::GetProxyFactory()
62{
63 return NetloadLimiterStatisticServiceProxyFactory::GetInstance();
64}
65
66}}}} // end of namespace Arp::Hardware::Nim::Services
Service for the netload limiter statistic handling
Definition: INetloadLimiterStatisticService.hpp:25
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:26
Base interface for all Rsc service interface.
Definition: IRscService.hpp:19
std::uint8_t uint8
The Arp unsigned integer type of 1 byte size.
Definition: PrimitiveTypes.hpp:27
NetloadLimiterErrorCode
This enum contains the error codes for the operations of the netload limiter services.
Definition: NetloadLimiterErrorCode.hpp:19
Namespace for classes and interfaces for the Remote Service Call implementation
Root namespace for the PLCnext API