PLCnext API Documentation 26.0.1.58
Public Types | Public Member Functions | List of all members
Arp::Base::Rsc::Commons::Services::IRscServiceProxy2 Class Referenceabstract

The interface of RSC service proxies used on client side to invoke services remotely. More...

#include <IRscServiceProxy2.hpp>

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

Public Types

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.
 

Public Member Functions

 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

- 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

The interface of RSC service proxies used on client side to invoke services remotely.

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

Member Function Documentation

◆ GetRscServiceHandle()

virtual const RscServiceHandle & Arp::Base::Rsc::Commons::Services::IRscServiceProxy2::GetRscServiceHandle ( void  ) const
pure virtual

Gets the RSC service handle of the remote service instance.

Returns
The RSC service handle of the remote service instance.

Implemented in Arp::Base::Rsc::Commons::Services::RscServiceProxyBase2.

◆ UpdateRscServiceHandle()

virtual void Arp::Base::Rsc::Commons::Services::IRscServiceProxy2::UpdateRscServiceHandle ( RscClient rscClient)
pure virtual

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

Parameters
rscClientThe RSC client to update the service handle from.

Implemented in Arp::Base::Rsc::Commons::Services::RscServiceProxyBase2.


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