PLCnext API Documentation 23.6.0.37
NetloadLimiterSettings.hpp
1
2//
3// Copyright PHOENIX CONTACT Electronics GmbH
4//
6#pragma once
8#include "Arp/System/Rsc/Services/IRscSerializable.hpp"
9#include "Arp/System/Rsc/Services/RscReader.hpp"
10#include "Arp/System/Rsc/Services/RscWriter.hpp"
11
12// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED
13
14namespace Arp { namespace Hardware { namespace Nim { namespace Services
15{
16
17using namespace Arp;
18using namespace Arp::System::Rsc::Services;
19
24{
25public:
29 boolean PacketLimiterEnabled = false;
30
34 boolean ByteLimiterEnabled = false;
35
41
47
48 void Serialize(RscWriter& writer)const override
49 {
50 writer.Write(this->PacketLimiterEnabled);
51 writer.Write(this->ByteLimiterEnabled);
52 writer.Write(this->PacketLimit);
53 writer.Write(this->ByteLimit);
54 }
55
56 void Deserialize(RscReader& reader)override
57 {
58 reader.Read(this->PacketLimiterEnabled);
59 reader.Read(this->ByteLimiterEnabled);
60 reader.Read(this->PacketLimit);
61 reader.Read(this->ByteLimit);
62 }
63
64 static constexpr size_t GetFieldCount(void)
65 {
66 return 4;
67 }
68};
69
70}}}} // end of namespace Arp::Hardware::Nim::Services
This struct contains all settings of the netload limiter. It is used to set and get the current setti...
Definition: NetloadLimiterSettings.hpp:24
void Deserialize(RscReader &reader) override
Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader.
Definition: NetloadLimiterSettings.hpp:56
uint32 ByteLimit
Count of allowed bytes per millisecond. This value is used if ByteLimiterEnabled is set to true....
Definition: NetloadLimiterSettings.hpp:46
boolean ByteLimiterEnabled
Flag to enable/disable byte limiter.
Definition: NetloadLimiterSettings.hpp:34
uint16 PacketLimit
Count of allowed packets per millisecond. This value is used if PacketLimiterEnabled is set to true....
Definition: NetloadLimiterSettings.hpp:40
void Serialize(RscWriter &writer) const override
Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter.
Definition: NetloadLimiterSettings.hpp:48
boolean PacketLimiterEnabled
Flag to enable/disable packet limiter.
Definition: NetloadLimiterSettings.hpp:29
Marshalls structure or class data types. Serialize and Deserialize have to marshal fields in the same...
Definition: IRscSerializable.hpp:20
Reads data from Rsc
Definition: RscReader.hpp:27
T Read(void)
Reads an element of T from Rsc. With data tagging enabled RscType of T is validated.
Definition: RscReader.hpp:166
Writes data to Rsc.
Definition: RscWriter.hpp:32
void Write(const T &value)
Writes an element of T from Rsc. Datatag and format is determined deducted by type of T.
Definition: RscWriter.hpp:178
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:36
std::uint16_t uint16
The Arp unsigned integer type of 2 byte size.
Definition: PrimitiveTypes.hpp:32
Namespace for classes and interfaces for the Remote Service Call implementation
Root namespace for the PLCnext API