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

Interface of RSC service proxies used on client side to invoke a service remotely. More...

#include <IRscServiceProxy.hpp>

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

Public Types

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

 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. 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

Interface of RSC service proxies used on client side to invoke a service remotely.

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

Constructor & Destructor Documentation

◆ IRscServiceProxy()

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

The default move constructor.

Parameters
argThe argument to move.

Member Function Documentation

◆ GetRscClient()

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

Gets the RscClient of this proxy.

Returns
The RscClient.

Implemented in Arp::Base::Rsc::Commons::Services::RscServiceProxyBase< T >.

◆ GetServiceHandle()

virtual RscHandle Arp::Base::Rsc::Commons::Services::IRscServiceProxy::GetServiceHandle ( void  )
pure virtual

Gets the service handle of the remote service instance.

Returns
The service handle of the remote service instance.

Implemented in Arp::Base::Rsc::Commons::Services::RscServiceProxyBase< T >.

◆ GetServiceName()

virtual String Arp::Base::Rsc::Commons::Services::IRscServiceProxy::GetServiceName ( void  ) const
pure virtual

Gets the service name of this proxy.

Returns
The service name of this proxy.

Implemented in Arp::Base::Rsc::Commons::Services::RscServiceProxyBase< T >.

◆ GetServiceProviderHandle()

virtual RscHandle Arp::Base::Rsc::Commons::Services::IRscServiceProxy::GetServiceProviderHandle ( void  )
pure virtual

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

Returns
The service handle of the remote service-provider instance

Implemented in Arp::Base::Rsc::Commons::Services::RscServiceProxyBase< T >.

◆ GetServiceProviderName()

virtual String Arp::Base::Rsc::Commons::Services::IRscServiceProxy::GetServiceProviderName ( void  ) const
pure virtual

Gets the service provider name of this proxy.

Returns
The service name provider of this proxy.

Implemented in Arp::Base::Rsc::Commons::Services::RscServiceProxyBase< T >.

◆ operator=()

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

The default move-assignment operator.

Parameters
argThe argument to move.
Returns
This instance.

◆ ReadServiceHandles()

virtual void Arp::Base::Rsc::Commons::Services::IRscServiceProxy::ReadServiceHandles ( void  )
pure virtual

Updates the service handle of the remote service instance.

Implemented in Arp::Base::Rsc::Commons::Services::RscServiceProxyBase< T >.


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