PLCnext API Documentation 25.0.2.69
ChannelInformation.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6#pragma once
8#include "Arp/Base/Rsc/Commons/Rsc.hpp"
9#include "Arp/Base/Rsc/Commons/RscSerializable.hpp"
10#include "Arp/Base/Rsc/Commons/RscString.hxx"
11#include "Arp/System/Um/Services/MessageSecurityMode.hpp"
12
13// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED
14
16{
17
18using namespace Arp;
19using namespace Arp::Base::Rsc::Commons;
20using namespace Arp::Base::Rsc::Commons::Services;
21
43class ARP_EXPORT ChannelInformation : public RscSerializable
44{
45public: // construction/destruction
47 ChannelInformation(uint32 gatewayID, const RscString<512>& protocolObjectName, MessageSecurityMode securityMode);
48
49public: // Properties
57 uint32 GatewayID = 0;
58
66
70 MessageSecurityMode SecurityMode = static_cast<MessageSecurityMode>(0);
71
72public: // Rsc operations
73 void Serialize(RscWriter& writer)const;
74 void Deserialize(RscReader& reader);
75 static size_t GetFieldCount(void);
76};
77
78} // end of namespace Arp::System::Um::Services
Any custom struct type which is intended to be marshalled in a Rsc serialization context,...
Definition: RscSerializable.hpp:35
Reads marshaled data of RSC services.
Definition: RscReader.hpp:34
Writes marshalled data of RSC services.
Definition: RscWriter.hpp:34
Describes an external channel at which the authentication of a user was requested.
Definition: ChannelInformation.hpp:44
RscString< 512 > ProtocolObjectName
A human readable name which describes the protocol which the gateway talks with a remote instance whi...
Definition: ChannelInformation.hpp:65
ChannelInformation(void)
Constructs an ChannelInformation instance.
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:33
Namespace for services of the User Manager (UM)
MessageSecurityMode
Describes the security measures which are applied to messages transported via a channel.
Definition: MessageSecurityMode.hpp:26
Root namespace for the PLCnext API