PLCnext API Documentation 25.0.2.69
Public Member Functions | List of all members
Arp::Base::Rsc::Commons::Services::RscSessionInfo Class Reference

This class compounds RSC session infos. More...

#include <RscSessionInfo.hpp>

Public Member Functions

 RscSessionInfo (Impl &impl)
 Constructs a RscSessionInfo instance. More...
 
 RscSessionInfo (const RscSessionInfo &arg)=delete
 
 RscSessionInfo (RscSessionInfo &&arg) noexcept
 The default move constructor. More...
 
RscSessionInfooperator= (const RscSessionInfo &arg)=delete
 
RscSessionInfooperator= (RscSessionInfo &&arg) noexcept
 The default move-assignment operator. More...
 
 ~RscSessionInfo (void)
 The default destructor.
 
size_t GetSessionId (void) const
 Gets the session ID of this instance. More...
 
int GetGatewayId (void) const
 Gets the gateway ID of this instance. More...
 
bool IsEncrypted (void) const
 Determines if this session uses encryption (TLS). More...
 
bool IsAuthenticated (void) const
 Determines if this session is authenticated. More...
 
RscCommunicationKind GetCommunicationKind (void) const
 Gets the communication kind of this instance. More...
 
Impl & GetImpl (void)
 For internal use only. More...
 
const Impl & GetImpl (void) const
 

Detailed Description

This class compounds RSC session infos.

This class is not intended for direct use, but required by RscGenerator to implement services.

Constructor & Destructor Documentation

◆ RscSessionInfo() [1/2]

Arp::Base::Rsc::Commons::Services::RscSessionInfo::RscSessionInfo ( Impl &  impl)

Constructs a RscSessionInfo instance.

Parameters
implThe impl instance.

◆ RscSessionInfo() [2/2]

Arp::Base::Rsc::Commons::Services::RscSessionInfo::RscSessionInfo ( RscSessionInfo &&  arg)
defaultnoexcept

The default move constructor.

Parameters
argThe argument to move.

Member Function Documentation

◆ GetCommunicationKind()

RscCommunicationKind Arp::Base::Rsc::Commons::Services::RscSessionInfo::GetCommunicationKind ( void  ) const

Gets the communication kind of this instance.

Returns
The communication kind of this instance.
See also
RscCommunicationKind

◆ GetGatewayId()

int Arp::Base::Rsc::Commons::Services::RscSessionInfo::GetGatewayId ( void  ) const

Gets the gateway ID of this instance.

Returns
The gateway ID of this instance.

◆ GetImpl()

const RscSessionInfo::Impl & Arp::Base::Rsc::Commons::Services::RscSessionInfo::GetImpl ( void  )

For internal use only.

Returns
The impl instance.

◆ GetSessionId()

size_t Arp::Base::Rsc::Commons::Services::RscSessionInfo::GetSessionId ( void  ) const

Gets the session ID of this instance.

Returns
The session ID of this instance.

◆ IsAuthenticated()

bool Arp::Base::Rsc::Commons::Services::RscSessionInfo::IsAuthenticated ( void  ) const

Determines if this session is authenticated.

Returns
true if this session is authenticated., otherwise false.

◆ IsEncrypted()

bool Arp::Base::Rsc::Commons::Services::RscSessionInfo::IsEncrypted ( void  ) const

Determines if this session uses encryption (TLS).

Returns
true if this session uses encryption, otherwise false.

◆ operator=()

RscSessionInfo & Arp::Base::Rsc::Commons::Services::RscSessionInfo::operator= ( RscSessionInfo &&  arg)
defaultnoexcept

The default move-assignment operator.

Parameters
argThe argument to move.
Returns
This instance.

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