Arp::Hardware::Nim::Services::INetloadLimiterService Class Reference

This Services controls the NetloadLimiter More...

#include <INetloadLimiterService.hpp>

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

Public Types
using	Ptr = std::shared_ptr< INetloadLimiterService >
Public Types inherited from Arp::System::Rsc::Services::IRscService
typedef std::shared_ptr< IRscService >	Ptr

Public Member Functions
	INetloadLimiterService (void)=default
	Constructs an INetloadLimiterService instance.
virtual NetloadLimiterErrorCode	GetSettings (uint8 networkInterface, NetloadLimiterSettings &settings)=0
	Gets the current settings for the selected network interface. More...
virtual NetloadLimiterErrorCode	SetSettings (uint8 networkInterface, const NetloadLimiterSettings &settings)=0
	Sets settings for selected network interface. More...
virtual NetloadLimiterErrorCode	SetByteLimit (uint8 networkInterface, uint32 limit)=0
	Sets new byte limit for the selected network interface. More...
virtual NetloadLimiterErrorCode	SetPacketLimit (uint8 networkInterface, uint16 limit)=0
	Sets new packet limit for the selected network interface. More...
virtual NetloadLimiterErrorCode	EnableByteLimiter (uint8 networkInterface)=0
	Enables the byte limiter for the selected network interface. More...
virtual NetloadLimiterErrorCode	DisableByteLimiter (uint8 networkInterface)=0
	Disables the byte limiter for the selected network interface. More...
virtual NetloadLimiterErrorCode	EnablePacketLimiter (uint8 networkInterface)=0
	Enables the packet limiter for the selected network interface. More...
virtual NetloadLimiterErrorCode	DisablePacketLimiter (uint8 networkInterface)=0
	Disables the packet limiter for the selected network interface. More...
virtual NetloadLimiterErrorCode	GetState (uint8 networkInterface, NetloadLimiterState &state)=0
	Gets the current state of the selected network interface. More...
Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
	IRscService (void)=default
	Constructs an IRscService instance.
virtual	~IRscService (void)=default
	Destructs this instance and frees all resouces.

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

Detailed Description

This Services controls the NetloadLimiter

This service is defined in library Arp.Hardware.Nim.

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

Member Function Documentation

DisableByteLimiter()

virtual NetloadLimiterErrorCode Arp::Hardware::Nim::Services::INetloadLimiterService::DisableByteLimiter ( uint8  networkInterface )

pure virtual

Disables the byte limiter for the selected network interface.

Parameters

networkInterface

Id of the network interface

Returns

Error code of operation

DisablePacketLimiter()

virtual NetloadLimiterErrorCode Arp::Hardware::Nim::Services::INetloadLimiterService::DisablePacketLimiter ( uint8  networkInterface )

pure virtual

Disables the packet limiter for the selected network interface.

Parameters

networkInterface

Id of the network interface

Returns

Error code of operation

EnableByteLimiter()

virtual NetloadLimiterErrorCode Arp::Hardware::Nim::Services::INetloadLimiterService::EnableByteLimiter ( uint8  networkInterface )

pure virtual

Enables the byte limiter for the selected network interface.

Parameters

networkInterface

Id of the network interface

Returns

Error code of operation

EnablePacketLimiter()

virtual NetloadLimiterErrorCode Arp::Hardware::Nim::Services::INetloadLimiterService::EnablePacketLimiter ( uint8  networkInterface )

pure virtual

Enables the packet limiter for the selected network interface.

Parameters

networkInterface

Id of the network interface

Returns

Error code of operation

GetSettings()

virtual NetloadLimiterErrorCode Arp::Hardware::Nim::Services::INetloadLimiterService::GetSettings ( uint8  networkInterface, NetloadLimiterSettings &  settings  )

pure virtual

Gets the current settings for the selected network interface.

Parameters

networkInterface	Id of the network interface
settings	Current settings of selected network interface

Returns

Error code of operation

GetState()

virtual NetloadLimiterErrorCode Arp::Hardware::Nim::Services::INetloadLimiterService::GetState ( uint8  networkInterface, NetloadLimiterState &  state  )

pure virtual

Gets the current state of the selected network interface.

Parameters

networkInterface	Id of the network interface
state	Current state of selected network interface

Returns

Error code of operation

SetByteLimit()

virtual NetloadLimiterErrorCode Arp::Hardware::Nim::Services::INetloadLimiterService::SetByteLimit ( uint8  networkInterface, uint32  limit  )

pure virtual

Sets new byte limit for the selected network interface.

Parameters

networkInterface	Id of the network interface
limit	New byte limit for the selected network interface

Returns

Error code of operation

SetPacketLimit()

virtual NetloadLimiterErrorCode Arp::Hardware::Nim::Services::INetloadLimiterService::SetPacketLimit ( uint8  networkInterface, uint16  limit  )

pure virtual

Sets new packet limit for the selected network interface.

Parameters

networkInterface	Id of the network interface
limit	New packet limit for the selected network interface

Returns

Error code of operation

SetSettings()

virtual NetloadLimiterErrorCode Arp::Hardware::Nim::Services::INetloadLimiterService::SetSettings ( uint8  networkInterface, const NetloadLimiterSettings &  settings  )

pure virtual

Sets settings for selected network interface.

Parameters

networkInterface	Id of the network interface
settings	New settings for the selected network interface

Returns

Error code of operation

---

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

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