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

Interface for service proxy factories to create service proxies used by RSC clients. More...

#include <IRscServiceProxyFactory.hpp>

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

Public Types

using Ptr = std::shared_ptr< IRscServiceProxyFactory >
 The shared pointer type of this proxy factory type.
 
using IRscServiceProxyPtr = std::shared_ptr< IRscServiceProxy >
 The shared pointer type of the service type.
 

Public Member Functions

 IRscServiceProxyFactory (void)=default
 The default constructor.
 
 IRscServiceProxyFactory (const IRscServiceProxyFactory &arg)=delete
 The deleted copy constructor.
 
 IRscServiceProxyFactory (IRscServiceProxyFactory &&arg) noexcept=default
 The default move constructor. More...
 
IRscServiceProxyFactoryoperator= (const IRscServiceProxyFactory &arg)=delete
 The deleted assignment operator.
 
IRscServiceProxyFactoryoperator= (IRscServiceProxyFactory &&arg) noexcept=default
 The default move-assignment operator. More...
 
virtual ~IRscServiceProxyFactory (void)=default
 Destructs this instance and frees all resources.
 
virtual const char * GetServiceName (void) const =0
 Gets the service name of the service type to be created by this factory. More...
 
virtual const char * GetServiceProviderName (void) const =0
 Gets the service-provider name of the service to be created by this factory. More...
 
virtual IRscServiceProxyPtr CreateServiceProxy (RscHandle providerHandle, RscHandle serviceHandle, RscClient &client)=0
 Creates a service proxy instance to be used by RSC clients remotely. More...
 

Detailed Description

Interface for service proxy factories to create service proxies used by RSC clients.

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

Constructor & Destructor Documentation

◆ IRscServiceProxyFactory()

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

The default move constructor.

Parameters
argThe argument to move.

Member Function Documentation

◆ CreateServiceProxy()

virtual IRscServiceProxyPtr Arp::Base::Rsc::Commons::Services::IRscServiceProxyFactory::CreateServiceProxy ( RscHandle  providerHandle,
RscHandle  serviceHandle,
RscClient client 
)
pure virtual

Creates a service proxy instance to be used by RSC clients remotely.

Parameters
providerHandleThe service-provider handle of the remote service-provider instance.
serviceHandleThe service handle of the remote service instance.
clientThe Rsc client providing the RSC connection.
Returns
A new created service-proxy instance.

◆ GetServiceName()

virtual const char * Arp::Base::Rsc::Commons::Services::IRscServiceProxyFactory::GetServiceName ( void  ) const
pure virtual

Gets the service name of the service type to be created by this factory.

Returns
The service name.

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

◆ GetServiceProviderName()

virtual const char * Arp::Base::Rsc::Commons::Services::IRscServiceProxyFactory::GetServiceProviderName ( void  ) const
pure virtual

Gets the service-provider name of the service to be created by this factory.

Returns
The service-provider name.

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

◆ operator=()

IRscServiceProxyFactory & Arp::Base::Rsc::Commons::Services::IRscServiceProxyFactory::operator= ( IRscServiceProxyFactory &&  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 file: