Arp::Hardware::Nim::Services::INetloadLimiterStatisticService Class Reference

Service for the netload limiter statistic handling More...

#include <INetloadLimiterStatisticService.hpp>

Inheritance diagram for Arp::Hardware::Nim::Services::INetloadLimiterStatisticService:

Public Types
using	Ptr = std::shared_ptr< INetloadLimiterStatisticService >
Public Types inherited from Arp::Base::Rsc::Commons::IRscService
using	Ptr = std::shared_ptr< IRscService >
	The shared_ptr type of IRscService.

Public Member Functions
	INetloadLimiterStatisticService (void)=default
	Constructs an INetloadLimiterStatisticService instance.
virtual NetloadLimiterStatisticResult	GetStatistic (uint8 networkInterfaceId)=0
	Read the statistic values of die specified network interface More...
virtual std::vector< NetloadLimiterStatisticResult >	GetStatistics (const std::vector< uint8 > &networkInterfaceIds)=0
	Read the statistic values of die specified network interfaces More...
virtual NetloadLimiterErrorCode	ResetStatistic (uint8 networkInterfaceId)=0
	Reset the statistic values Max, Peak and Duration of the packet and byte statistics for the specified interface. More...
Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService
	IRscService (void)=default
	The default constructor.
	IRscService (const IRscService &arg)=delete
	The deleted copy constructor. More...
	IRscService (IRscService &&arg) noexcept=default
	The default move constructor. More...
IRscService &	operator= (const IRscService &arg)=delete
	The deleted assignment operator. More...
IRscService &	operator= (IRscService &&arg) noexcept=default
	The default move-assignment operator. More...
virtual	~IRscService (void)=default
	Destructs this instance and frees all resources.

Static Public Member Functions
static IRscServiceProxyFactory &	GetProxyFactory (void)
Static Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService
static IRscServiceProxyFactory &	GetProxyFactory (void)
	Returns a reference to service proxy factory to create a proxy instance of this service. More...

Detailed Description

Service for the netload limiter statistic handling

Realtime Usage: This API call does not have to be deterministic in runtime behaviour, so an asynchronous execution should be considered.

Member Function Documentation

GetStatistic()

virtual NetloadLimiterStatisticResult Arp::Hardware::Nim::Services::INetloadLimiterStatisticService::GetStatistic ( uint8  networkInterfaceId )

pure virtual

Read the statistic values of die specified network interface

Parameters

networkInterfaceId

Id of the network interface

Returns

Result of operation

GetStatistics()

virtual std::vector< NetloadLimiterStatisticResult > Arp::Hardware::Nim::Services::INetloadLimiterStatisticService::GetStatistics ( const std::vector< uint8 > &  networkInterfaceIds )

pure virtual

Read the statistic values of die specified network interfaces

Parameters

networkInterfaceIds

Array of network interface ids. An empty array addresses all network adapters

Returns

Result array of operation

ResetStatistic()

virtual NetloadLimiterErrorCode Arp::Hardware::Nim::Services::INetloadLimiterStatisticService::ResetStatistic ( uint8  networkInterfaceId )

pure virtual

Reset the statistic values Max, Peak and Duration of the packet and byte statistics for the specified interface.

Parameters

networkInterfaceId

Id of the network interface. 0 to address all network adapters

Returns

Error code of operation

---

The documentation for this class was generated from the following file:

• Arp/Hardware/Nim/Services/INetloadLimiterStatisticService.hpp