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

Base class of all RSC service proxies. More...

#include <RscServiceProxyBase2.hpp>

Inheritance diagram for Arp::Base::Rsc::Commons::Services::RscServiceProxyBase2:
Inheritance graph

Public Member Functions

 RscServiceProxyBase2 (const RscServiceProxyInfo &serviceProxyInfo, RscClient &rscClient)
 Constructs a RscServiceProxyBase2 instance. More...
 
 RscServiceProxyBase2 (const RscServiceProxyBase2 &arg)=delete
 
 RscServiceProxyBase2 (RscServiceProxyBase2 &&arg) noexcept
 The default move constructor. More...
 
RscServiceProxyBase2operator= (const RscServiceProxyBase2 &arg)=delete
 
RscServiceProxyBase2operator= (RscServiceProxyBase2 &&arg) noexcept
 The default move-assignment operator. More...
 
 ~RscServiceProxyBase2 (void)
 The default destructor.
 
RscClientGetRscClient (void) const
 Gets the RscClient of this proxy. More...
 
String GetServiceName (void) const override
 Gets the service name of this proxy. More...
 
String GetServiceProviderName (void) const override
 Gets the service provider name of this proxy. More...
 
RscHandle GetServiceHandle (void) override
 Gets the service handle of the remote service instance. More...
 
RscHandle GetServiceProviderHandle (void) override
 Gets the service handle of the remote service-provider instance. More...
 
void ReadServiceHandles (void) override
 Updates the service handle of the remote service instance, e.g. when a reconnect occurs. More...
 
const RscServiceHandleGetRscServiceHandle (void) const override
 Gets the RSC service handle of the remote service instance. More...
 
void UpdateRscServiceHandle (RscClient &rscClient) override
 Updates the service handle of the remote service instance using the supplied client. More...
 
Impl & GetImpl (void)
 For internal use only. More...
 
const Impl & GetImpl (void) const
 
- Public Member Functions inherited from Arp::Base::Rsc::Commons::Services::IRscServiceProxy2
 IRscServiceProxy2 (void)=default
 Constructs an IRscServiceProxy2 instance.
 
 IRscServiceProxy2 (const IRscServiceProxy2 &arg)=delete
 The default copy constructor.
 
 IRscServiceProxy2 (IRscServiceProxy2 &&arg) noexcept=default
 The default move constructor.
 
IRscServiceProxy2operator= (const IRscServiceProxy2 &arg)=delete
 The default copy-assignment operator.
 
IRscServiceProxy2operator= (IRscServiceProxy2 &&arg) noexcept=default
 The default move-assignment operator.
 
virtual ~IRscServiceProxy2 (void)=default
 Destructs this instance and frees all resources.
 
virtual const RscServiceHandleGetRscServiceHandle (void) const =0
 Gets the RSC service handle of the remote service instance. More...
 
virtual void UpdateRscServiceHandle (RscClient &rscClient)=0
 Updates the service handle of the refered remote service instance, e.g. when a reconnect occurs. More...
 
- Public Member Functions inherited from Arp::Base::Rsc::Commons::Services::IRscServiceProxy
 IRscServiceProxy (void)=default
 The default constructor.
 
 IRscServiceProxy (const IRscServiceProxy &arg)=delete
 The deleted copy constructor.
 
 IRscServiceProxy (IRscServiceProxy &&arg) noexcept=default
 The default move constructor. More...
 
IRscServiceProxyoperator= (const IRscServiceProxy &)=delete
 The deleted assignment operator.
 
IRscServiceProxyoperator= (IRscServiceProxy &&arg) noexcept=default
 The default move-assignment operator. More...
 
virtual ~IRscServiceProxy (void)=default
 Destructs this instance and frees all resources.
 
virtual RscClientGetRscClient (void) const =0
 Gets the RscClient of this proxy. More...
 
virtual String GetServiceName (void) const =0
 Gets the service name of this proxy. More...
 
virtual String GetServiceProviderName (void) const =0
 Gets the service provider name of this proxy. More...
 
virtual RscHandle GetServiceHandle (void)=0
 Gets the service handle of the remote service instance. More...
 
virtual RscHandle GetServiceProviderHandle (void)=0
 Gets the service handle of the remote service-provider instance. More...
 
virtual void ReadServiceHandles (void)=0
 Updates the service handle of the remote service instance, e.g. when a reconnect occurs. More...
 
- Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService
 IRscService (void)=default
 The default constructor.
 
 IRscService (const IRscService &arg)=delete
 The deleted copy constructor. More...
 
 IRscService (IRscService &&arg) noexcept=default
 The default move constructor. More...
 
IRscServiceoperator= (const IRscService &arg)=delete
 The deleted assignment operator. More...
 
IRscServiceoperator= (IRscService &&arg) noexcept=default
 The default move-assignment operator. More...
 
virtual ~IRscService (void)=default
 Destructs this instance and frees all resources.
 

Additional Inherited Members

- Public Types inherited from Arp::Base::Rsc::Commons::Services::IRscServiceProxy2
using Ptr = std::shared_ptr< IRscServiceProxy2 >
 The pointer type of this interface.
 
- Public Types inherited from Arp::Base::Rsc::Commons::Services::IRscServiceProxy
using Ptr = std::shared_ptr< IRscServiceProxy >
 The pointer type of this type.
 
- Public Types inherited from Arp::Base::Rsc::Commons::IRscService
using Ptr = std::shared_ptr< IRscService >
 The shared_ptr type of IRscService.
 
- Static Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService
static IRscServiceProxyFactoryGetProxyFactory (void)
 Returns a reference to service proxy factory to create a proxy instance of this service. More...
 

Detailed Description

Base class of all RSC service proxies.

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

Constructor & Destructor Documentation

◆ RscServiceProxyBase2() [1/2]

Arp::Base::Rsc::Commons::Services::RscServiceProxyBase2::RscServiceProxyBase2 ( const RscServiceProxyInfo serviceProxyInfo,
RscClient rscClient 
)

Constructs a RscServiceProxyBase2 instance.

Parameters
serviceProxyInfoContains all proxy specific infos.
rscClientThe RSC client which estbalished the connection used by the proxy.

◆ RscServiceProxyBase2() [2/2]

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

The default move constructor.

Parameters
argThe argument to move.

Member Function Documentation

◆ GetImpl()

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

For internal use only.

Returns
The impl instance.

◆ GetRscClient()

RscClient & Arp::Base::Rsc::Commons::Services::RscServiceProxyBase2::GetRscClient ( void  ) const
virtual

◆ GetRscServiceHandle()

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

Gets the RSC service handle of the remote service instance.

Implements Arp::Base::Rsc::Commons::Services::IRscServiceProxy2.

◆ GetServiceHandle()

RscHandle Arp::Base::Rsc::Commons::Services::RscServiceProxyBase2::GetServiceHandle ( void  )
overridevirtual

Gets the service handle of the remote service instance.

Implements Arp::Base::Rsc::Commons::Services::IRscServiceProxy.

◆ GetServiceName()

String Arp::Base::Rsc::Commons::Services::RscServiceProxyBase2::GetServiceName ( void  ) const
overridevirtual

Gets the service name of this proxy.

Implements Arp::Base::Rsc::Commons::Services::IRscServiceProxy.

◆ GetServiceProviderHandle()

RscHandle Arp::Base::Rsc::Commons::Services::RscServiceProxyBase2::GetServiceProviderHandle ( void  )
overridevirtual

Gets the service handle of the remote service-provider instance.

Implements Arp::Base::Rsc::Commons::Services::IRscServiceProxy.

◆ GetServiceProviderName()

String Arp::Base::Rsc::Commons::Services::RscServiceProxyBase2::GetServiceProviderName ( void  ) const
overridevirtual

Gets the service provider name of this proxy.

Implements Arp::Base::Rsc::Commons::Services::IRscServiceProxy.

◆ operator=()

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

The default move-assignment operator.

Parameters
argThe argument to move.
Returns
This instance.

◆ ReadServiceHandles()

void Arp::Base::Rsc::Commons::Services::RscServiceProxyBase2::ReadServiceHandles ( void  )
overridevirtual

Updates the service handle of the remote service instance, e.g. when a reconnect occurs.

Implements Arp::Base::Rsc::Commons::Services::IRscServiceProxy.

◆ UpdateRscServiceHandle()

void Arp::Base::Rsc::Commons::Services::RscServiceProxyBase2::UpdateRscServiceHandle ( RscClient rscClient)
overridevirtual

Updates the service handle of the remote service instance using the supplied client.

Parameters
rscClientThe client to update the service handle from.

Implements Arp::Base::Rsc::Commons::Services::IRscServiceProxy2.


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