PLCnext API Documentation  22.9.0.33
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Arp::Hardware::Nim::Services::NetloadLimiterSettings Class Reference

This struct contains all settings of the netload limiter. It is used to set and get the current settings. More...

#include <NetloadLimiterSettings.hpp>

Inheritance diagram for Arp::Hardware::Nim::Services::NetloadLimiterSettings:
Inheritance graph

Public Member Functions

void Serialize (RscWriter &writer) const override
 Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter. More...
 
void Deserialize (RscReader &reader) override
 Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader. More...
 
- Public Member Functions inherited from Arp::System::Rsc::Services::IRscSerializable
virtual ~IRscSerializable ()=default
 default destructor More...
 

Static Public Member Functions

static constexpr size_t GetFieldCount (void)
 
- Static Public Member Functions inherited from Arp::System::Rsc::Services::IRscSerializable
static size_t GetFieldCount (void)
 Returns the count of fields of the struct type More...
 

Public Attributes

boolean PacketLimiterEnabled = false
 Flag to enable/disable packet limiter. More...
 
boolean ByteLimiterEnabled = false
 Flag to enable/disable byte limiter. More...
 
uint16 PacketLimit = 0
 Count of allowed packets per millisecond. This value is used if PacketLimiterEnabled is set to true. 0 means no network communication allowed. More...
 
uint32 ByteLimit = 0
 Count of allowed bytes per millisecond. This value is used if ByteLimiterEnabled is set to true. 0 means no network communication allowed. More...
 

Detailed Description

This struct contains all settings of the netload limiter. It is used to set and get the current settings.

Member Function Documentation

◆ Deserialize()

void Arp::Hardware::Nim::Services::NetloadLimiterSettings::Deserialize ( RscReader reader)
inlineoverridevirtual

Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader.

Parameters
readerReference to RscReader.

Implements Arp::System::Rsc::Services::IRscSerializable.

◆ Serialize()

void Arp::Hardware::Nim::Services::NetloadLimiterSettings::Serialize ( RscWriter writer) const
inlineoverridevirtual

Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter.

Parameters
writerReference to RscWriter

Implements Arp::System::Rsc::Services::IRscSerializable.

Member Data Documentation

◆ ByteLimit

uint32 Arp::Hardware::Nim::Services::NetloadLimiterSettings::ByteLimit = 0

Count of allowed bytes per millisecond. This value is used if ByteLimiterEnabled is set to true. 0 means no network communication allowed.

◆ ByteLimiterEnabled

boolean Arp::Hardware::Nim::Services::NetloadLimiterSettings::ByteLimiterEnabled = false

Flag to enable/disable byte limiter.

◆ PacketLimit

uint16 Arp::Hardware::Nim::Services::NetloadLimiterSettings::PacketLimit = 0

Count of allowed packets per millisecond. This value is used if PacketLimiterEnabled is set to true. 0 means no network communication allowed.

◆ PacketLimiterEnabled

boolean Arp::Hardware::Nim::Services::NetloadLimiterSettings::PacketLimiterEnabled = false

Flag to enable/disable packet limiter.


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