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

This class contains all infos of a RSC service proxy. More...

#include <RscServiceProxyInfo.hpp>

Public Member Functions

 RscServiceProxyInfo (const RscServiceHandle &serviceHandle, const char *serviceName, const String &serviceProviderName)
 Constructs a RscServiceProxyInfo instance. More...
 
 RscServiceProxyInfo (const RscServiceProxyInfo &arg)
 The default copy constructor. More...
 
 RscServiceProxyInfo (RscServiceProxyInfo &&arg) noexcept
 The default move constructor. More...
 
RscServiceProxyInfo & operator= (const RscServiceProxyInfo &arg)
 The default copy-assignment operator. More...
 
RscServiceProxyInfo & operator= (RscServiceProxyInfo &&arg) noexcept
 The default move-assignment operator. More...
 
 ~RscServiceProxyInfo (void)
 The default destructor.
 
const RscServiceHandle & GetRscServiceHandle (void) const
 Gets the RSC service handle, i.e. the service address. More...
 
const String & GetServiceName (void) const
 Gets the full service type name of the proxy. More...
 
const String & GetServiceProviderName (void) const
 Gets the service provider name of the proxy. More...
 
void ReadServiceHandle (RscClient &client)
 Updates this proxy when the client connection has been restored. More...
 
Impl & GetImpl (void)
 For internal use only. More...
 
const Impl & GetImpl (void) const
 

Detailed Description

This class contains all infos of a RSC service proxy.

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

Constructor & Destructor Documentation

◆ RscServiceProxyInfo() [1/3]

Arp::Base::Rsc::Commons::Services::RscServiceProxyInfo::RscServiceProxyInfo ( const RscServiceHandle &  serviceHandle,
const char *  serviceName,
const String &  serviceProviderName 
)

Constructs a RscServiceProxyInfo instance.

Parameters
serviceHandle
serviceNameThe full service typename.
serviceProviderNameThe service-provider name.

◆ RscServiceProxyInfo() [2/3]

Arp::Base::Rsc::Commons::Services::RscServiceProxyInfo::RscServiceProxyInfo ( const RscServiceProxyInfo &  arg)
default

The default copy constructor.

Parameters
argThe argument to copy.

◆ RscServiceProxyInfo() [3/3]

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

The default move constructor.

Parameters
argThe argument to move.

Member Function Documentation

◆ GetImpl()

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

For internal use only.

Returns
The impl instance.

◆ GetRscServiceHandle()

const RscServiceHandle & Arp::Base::Rsc::Commons::Services::RscServiceProxyInfo::GetRscServiceHandle ( void  ) const

Gets the RSC service handle, i.e. the service address.

Returns
The RSC service handle

◆ GetServiceName()

const String & Arp::Base::Rsc::Commons::Services::RscServiceProxyInfo::GetServiceName ( void  ) const

Gets the full service type name of the proxy.

Returns
The full service type name of the proxy.

◆ GetServiceProviderName()

const String & Arp::Base::Rsc::Commons::Services::RscServiceProxyInfo::GetServiceProviderName ( void  ) const

Gets the service provider name of the proxy.

Returns
The service provider name of the proxy.

◆ operator=() [1/2]

RscServiceProxyInfo & Arp::Base::Rsc::Commons::Services::RscServiceProxyInfo::operator= ( const RscServiceProxyInfo &  arg)
default

The default copy-assignment operator.

Parameters
argThe argument to copy.
Returns
This instance.

◆ operator=() [2/2]

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

The default move-assignment operator.

Parameters
argThe argument to move.
Returns
This instance.

◆ ReadServiceHandle()

void Arp::Base::Rsc::Commons::Services::RscServiceProxyInfo::ReadServiceHandle ( RscClient &  client)

Updates this proxy when the client connection has been restored.

Parameters
clientThe client which has been reconnected.

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