PLCnext API Documentation
20.6.0.30321
|
This Services controls the NetloadLimiter More...
#include <INetloadLimiterService.hpp>
Public Types | |
typedef std::shared_ptr< INetloadLimiterService > | Ptr |
Public Types inherited from Arp::System::Rsc::Services::IRscService | |
typedef std::shared_ptr< IRscService > | Ptr |
Public Member Functions | |
INetloadLimiterService (void) | |
Constructs an INetloadLimiterService instance. More... | |
virtual | ~INetloadLimiterService (void) |
Destructs this instance and frees all resouces. More... | |
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. More... | |
virtual | ~IRscService (void)=default |
Destructs this instance and frees all resouces. More... | |
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... | |
This Services controls the NetloadLimiter
|
inline |
Constructs an INetloadLimiterService instance.
|
inlinevirtual |
Destructs this instance and frees all resouces.
|
pure virtual |
Disables the byte limiter for the selected network interface.
networkInterface | Id of the network interface |
|
pure virtual |
Disables the packet limiter for the selected network interface.
networkInterface | Id of the network interface |
|
pure virtual |
Enables the byte limiter for the selected network interface.
networkInterface | Id of the network interface |
|
pure virtual |
Enables the packet limiter for the selected network interface.
networkInterface | Id of the network interface |
|
pure virtual |
Gets the current settings for the selected network interface.
networkInterface | Id of the network interface |
settings | Current settings of selected network interface |
|
pure virtual |
Gets the current state of the selected network interface.
networkInterface | Id of the network interface |
state | Current state of selected network interface |
|
pure virtual |
Sets new byte limit for the selected network interface.
networkInterface | Id of the network interface |
limit | New byte limit for the selected network interface |
|
pure virtual |
Sets new packet limit for the selected network interface.
networkInterface | Id of the network interface |
limit | New packet limit for the selected network interface |
|
pure virtual |
Sets settings for selected network interface.
networkInterface | Id of the network interface |
settings | New settings for the selected network interface |