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

This class is used for adressing RSC service instances remotely. More...

#include <RscServiceHandle.hpp>

Public Member Functions

 RscServiceHandle (void)
 The default constructor creates an empty RscServiceHandle.
 
 RscServiceHandle (RscHandle serviceProviderHandle, RscHandle serviceHandle)
 Constructs a RscServiceHandle instance. More...
 
 RscServiceHandle (const RscServiceHandle &arg)
 The default copy constructor. More...
 
 RscServiceHandle (RscServiceHandle &&arg) noexcept
 The default move constructor. More...
 
RscServiceHandleoperator= (const RscServiceHandle &arg)
 The default copy-assignment operator. More...
 
RscServiceHandleoperator= (RscServiceHandle &&arg) noexcept
 The default move-assignment operator. More...
 
 ~RscServiceHandle (void)
 The default destructor.
 
void SetServiceHandle (RscHandle value)
 Sets the service handle of this RscServiceHandle. More...
 
RscHandle GetServiceHandle (void) const
 Gets the service handle of this RscServiceHandle. More...
 
void SetServiceProviderHandle (RscHandle value)
 Sets the service provider handle of this RscServiceHandle. More...
 
RscHandle GetServiceProviderHandle (void) const
 Gets the service provider handle of this RscServiceHandle. More...
 
size_t GetHashValue (void) const
 Gets the hash value of this instance. More...
 
Impl & GetImpl (void)
 For internal use only. More...
 
const Impl & GetImpl (void) const
 

Friends

bool operator== (const RscServiceHandle &lhs, const RscServiceHandle &rhs)
 The equality operator compares the arguments. More...
 

Detailed Description

This class is used for adressing RSC service instances remotely.

This class is used to address service instances, which shall be invoked by RSC remotely or via IPC. The address depends on the service type and the connection between the client and remote peer, where the latter might be another process or another machine. This class is not intended for direct use, but required by RscGenerator to implement services.

Constructor & Destructor Documentation

◆ RscServiceHandle() [1/3]

Arp::Base::Rsc::Commons::Services::RscServiceHandle::RscServiceHandle ( RscHandle  serviceHandle,
RscHandle  serviceProviderHandle 
)

Constructs a RscServiceHandle instance.

Parameters
serviceHandleThe service handle.
serviceProviderHandleThe service-provider handle.

◆ RscServiceHandle() [2/3]

Arp::Base::Rsc::Commons::Services::RscServiceHandle::RscServiceHandle ( const RscServiceHandle arg)
default

The default copy constructor.

Parameters
argThe argument to copy.

◆ RscServiceHandle() [3/3]

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

The default move constructor.

Parameters
argThe argument to move.

Member Function Documentation

◆ GetHashValue()

size_t Arp::Base::Rsc::Commons::Services::RscServiceHandle::GetHashValue ( void  ) const

Gets the hash value of this instance.

Returns
The hash value of this instance.

◆ GetImpl()

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

For internal use only.

Returns
The impl instance.

◆ GetServiceHandle()

RscHandle Arp::Base::Rsc::Commons::Services::RscServiceHandle::GetServiceHandle ( void  ) const

Gets the service handle of this RscServiceHandle.

Returns
The value of the service handle of this RscServiceHandle.

◆ GetServiceProviderHandle()

RscHandle Arp::Base::Rsc::Commons::Services::RscServiceHandle::GetServiceProviderHandle ( void  ) const

Gets the service provider handle of this RscServiceHandle.

Returns
The value of the service provider handle of this RscServiceHandle.

◆ operator=() [1/2]

RscServiceHandle & Arp::Base::Rsc::Commons::Services::RscServiceHandle::operator= ( const RscServiceHandle arg)
default

The default copy-assignment operator.

Parameters
argThe argument to copy.
Returns
This instance.

◆ operator=() [2/2]

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

The default move-assignment operator.

Parameters
argThe argument to move.
Returns
This instance.

◆ SetServiceHandle()

void Arp::Base::Rsc::Commons::Services::RscServiceHandle::SetServiceHandle ( RscHandle  value)

Sets the service handle of this RscServiceHandle.

Parameters
valueSpecifies the new service handle value of this RscServiceHandle.

◆ SetServiceProviderHandle()

void Arp::Base::Rsc::Commons::Services::RscServiceHandle::SetServiceProviderHandle ( RscHandle  value)

Sets the service provider handle of this RscServiceHandle.

Parameters
valueSpecifies the new service provider handle value of this RscServiceHandle.

Friends And Related Function Documentation

◆ operator==

bool operator== ( const RscServiceHandle lhs,
const RscServiceHandle rhs 
)
friend

The equality operator compares the arguments.

Parameters
lhsThe left argument to compare to the right argument.
rhsThe right argument to compare to the left argument.
Returns
true if the arguments are equal, otherwise false.

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