PLCnext API Documentation 25.0.2.69
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

 NetloadLimiterSettings (void)
 Constructs an NetloadLimiterSettings instance.
 
 NetloadLimiterSettings (boolean packetLimiterEnabled, boolean byteLimiterEnabled, uint16 packetLimit, uint32 byteLimit)
 Constructs an NetloadLimiterSettings instance.
 
void Serialize (RscWriter &writer) const
 Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter. More...
 
void Deserialize (RscReader &reader)
 Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader. More...
 
void Serialize (JRscWriter &writer) const
 Serializes the datatype. All fields of the datatype have to be serialized in use of JRscWriter. More...
 
void Deserialize (JRscReader &reader)
 Deserializes the datatype. All fields of the datatype have to be deserialized in use of JRscReader. More...
 
- Public Member Functions inherited from Arp::Base::Rsc::Commons::RscSerializable
 RscSerializable (void)=default
 The default constructor.
 

Static Public Member Functions

static size_t GetFieldCount (void)
 Returns the count of fields More...
 

Public Attributes

boolean PacketLimiterEnabled = false
 Flag to enable/disable packet limiter.
 
boolean ByteLimiterEnabled = false
 Flag to enable/disable byte limiter.
 
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.
 
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.
 

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() [1/2]

void Arp::Hardware::Nim::Services::NetloadLimiterSettings::Deserialize ( JRscReader &  reader)

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

Parameters
readerReference to RscReader.

◆ Deserialize() [2/2]

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

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

Parameters
readerReference to RscReader.

◆ GetFieldCount()

size_t Arp::Hardware::Nim::Services::NetloadLimiterSettings::GetFieldCount ( void  )
static

Returns the count of fields

Returns
Count of fields.

The field count is used for serialization via Rsc

◆ Serialize() [1/2]

void Arp::Hardware::Nim::Services::NetloadLimiterSettings::Serialize ( JRscWriter &  writer) const

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

Parameters
writerReference to RscWriter

◆ Serialize() [2/2]

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

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

Parameters
writerReference to RscWriter

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