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

Base class for RSC service proxy factory implementations. More...

#include <RscServiceProxyFactoryBase.hpp>

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

Public Member Functions

 RscServiceProxyFactoryBase (const char *serviceName, const char *serviceProviderName="")
 Constructs an RscServiceProxyFactoryBase instance. More...
 
 RscServiceProxyFactoryBase (const RscServiceProxyFactoryBase &arg)=delete
 
 RscServiceProxyFactoryBase (RscServiceProxyFactoryBase &&arg) noexcept
 The default move constructor. More...
 
RscServiceProxyFactoryBaseoperator= (const RscServiceProxyFactoryBase &arg)=delete
 
RscServiceProxyFactoryBaseoperator= (RscServiceProxyFactoryBase &&arg) noexcept
 The default move-assignment operator. More...
 
 ~RscServiceProxyFactoryBase (void) override
 The default destructor.
 
const char * GetServiceName (void) const override
 Gets the service name of this proxy factory. More...
 
const char * GetServiceProviderName (void) const override
 Gets the service provider name of this proxy factory. More...
 
Impl & GetImpl (void)
 For internal use only. More...
 
const Impl & GetImpl (void) const
 
- Public Member Functions inherited from Arp::Base::Rsc::Commons::Services::IRscServiceProxyFactory
 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...
 

Additional Inherited Members

- Public Types inherited from Arp::Base::Rsc::Commons::Services::IRscServiceProxyFactory
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.
 

Detailed Description

Base class for RSC service proxy factory implementations.

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

Constructor & Destructor Documentation

◆ RscServiceProxyFactoryBase() [1/2]

Arp::Base::Rsc::Commons::Services::RscServiceProxyFactoryBase::RscServiceProxyFactoryBase ( const char *  serviceName,
const char *  serviceProviderName = "" 
)
explicit

Constructs an RscServiceProxyFactoryBase instance.

Parameters
serviceNameThe full qualified service name.
serviceProviderNameThe service-provider name.

◆ RscServiceProxyFactoryBase() [2/2]

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

The default move constructor.

Parameters
argThe argument to move.

Member Function Documentation

◆ GetImpl()

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

For internal use only.

Returns
The impl instance.

◆ GetServiceName()

const char * Arp::Base::Rsc::Commons::Services::RscServiceProxyFactoryBase::GetServiceName ( void  ) const
overridevirtual

Gets the service name of this proxy factory.

Returns
The service name.

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

◆ GetServiceProviderName()

const char * Arp::Base::Rsc::Commons::Services::RscServiceProxyFactoryBase::GetServiceProviderName ( void  ) const
overridevirtual

Gets the service provider name of this proxy factory.

Returns
The service provider name.

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

◆ operator=()

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