PLCnext API Documentation 23.6.0.37
ChannelInformation.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/RscString.hxx"
11#include "Arp/System/Rsc/Services/RscWriter.hpp"
12#include "Arp/System/Um/Services/MessageSecurityMode.hpp"
13
14// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED
15
16namespace Arp { namespace System { namespace Um { namespace Services
17{
18
19using namespace Arp;
20using namespace Arp::System::Rsc::Services;
21
44{
45public:
54
62
67
68 void Serialize(RscWriter& writer)const override
69 {
70 writer.Write(this->GatewayID);
71 writer.Write(this->ProtocolObjectName);
72 writer.Write(this->SecurityMode);
73 }
74
75 void Deserialize(RscReader& reader)override
76 {
77 reader.Read(this->GatewayID);
78 reader.Read(this->ProtocolObjectName);
79 reader.Read(this->SecurityMode);
80 }
81
82 static constexpr size_t GetFieldCount(void)
83 {
84 return 3;
85 }
86};
87
88}}}} // end of namespace Arp::System::Um::Services
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
Describes an external channel at which the authentication of a user was requested.
Definition: ChannelInformation.hpp:44
void Serialize(RscWriter &writer) const override
Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter.
Definition: ChannelInformation.hpp:68
uint32 GatewayID
An identifier of the gateway at which the user authentication was processed first.
Definition: ChannelInformation.hpp:53
RscString< 512 > ProtocolObjectName
A human readable name which describes the protocol which the gateway talks with a remote instance whi...
Definition: ChannelInformation.hpp:61
void Deserialize(RscReader &reader) override
Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader.
Definition: ChannelInformation.hpp:75
MessageSecurityMode SecurityMode
Information about the authenticity and secrecy of messages received and sent through the external cha...
Definition: ChannelInformation.hpp:66
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:36
@ System
System components used by the System, Device, Plc or Io domains.
Namespace for classes and interfaces for the Remote Service Call implementation
MessageSecurityMode
Describes the security measures which are applied to messages transported via a channel.
Definition: MessageSecurityMode.hpp:26
Root namespace for the PLCnext API