Describes an external channel at which the authentication of a user was requested. More...

#include <ChannelInformation.hpp>

Inheritance diagram for Arp::System::Um::Services::ChannelInformation:

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
uint32	GatewayID = 0
	An identifier of the gateway at which the user authentication was processed first. More...

RscString< 512 >	ProtocolObjectName
	A human readable name which describes the protocol which the gateway talks with a remote instance which authenticates a user. More...

MessageSecurityMode	SecurityMode = static_cast<MessageSecurityMode>(0)
	Information about the authenticity and secrecy of messages received and sent through the external channel. More...

Detailed Description

Describes an external channel at which the authentication of a user was requested.

External is meant relative to the PLCnext technology.

An external channel can be an external TCP-based Remoting connection from a Remoting client to the RSC-gateway. In that case the RSC-gateway processes the user authentication request of the user and then asks the UserManager internally via IPC-based or in-process Remoting call to actually perform the authentication and create the session. This second call is then an internal channel. The channel information contained in an instance of this object is then used to augment session context information within the UserManager.

Another example of an external channel can be an external OPC UA connection from an OPC UA client to the embedded OPC UA server built-in into PLCnext technology. In that case the OPC UA server processes the user authentication request and then asks the UserManager internally via IPC-Based or in-process Remoting call to actually perform the authentication and create the session.

Member Function Documentation

◆ Deserialize()

void Arp::System::Um::Services::ChannelInformation::Deserialize ( RscReader & reader )

inlineoverridevirtual

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

Parameters

reader Reference to RscReader.

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

◆ Serialize()

void Arp::System::Um::Services::ChannelInformation::Serialize ( RscWriter & writer ) const

inlineoverridevirtual

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

Parameters

writer Reference to RscWriter

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

Member Data Documentation

◆ GatewayID

uint32 Arp::System::Um::Services::ChannelInformation::GatewayID = 0

An identifier of the gateway at which the user authentication was processed first.

The value of

GatewayID

Arp::System::Um::Services::ChannelInformation::GatewayID

uint32 GatewayID

An identifier of the gateway at which the user authentication was processed first.

Definition: ChannelInformation.hpp:53

has meaning only internally to the PLCnext technology device because it depends on its current configuration.

◆ ProtocolObjectName

RscString<512> Arp::System::Um::Services::ChannelInformation::ProtocolObjectName

A human readable name which describes the protocol which the gateway talks with a remote instance which authenticates a user.

Examples:

value	description
arp.static.device/rsc.tcp:41100	The RSC-gateway listening at TCP port 41100.
arp.static.device/opc.tcp:4840	The OPC UA server listening at TCP port 4840.

◆ SecurityMode

MessageSecurityMode Arp::System::Um::Services::ChannelInformation::SecurityMode = static_cast<MessageSecurityMode>(0)

Information about the authenticity and secrecy of messages received and sent through the external channel.

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

Arp/System/Um/Services/ChannelInformation.hpp

Public Member Functions

Static Public Member Functions

Public Attributes