Imt.Base C++ API V4.1.1.0
Loading...
Searching...
No Matches
imt::base::lib::remoting::RemotingServiceIfc Class Referenceabstract

Interface for the RemotingService. More...

#include <Imt.Base.Lib.Remoting/inc/Imt.Base.Lib.Remoting/RemotingServiceIfc.h>

Inheritance diagram for imt::base::lib::remoting::RemotingServiceIfc:
imt::base::lib::remoting::RemotingSendServiceIfc imt::base::lib::remoting::RemotingServiceBase imt::base::lib::remoting::RemotingSendService imt::base::lib::remoting::RemotingReceiveService imt::base::lib::remoting::RemotingSendService

Public Member Functions

virtual ~RemotingServiceIfc ()=default
 Destructor.
 
virtual bool isRemoteObjectAdded (RemoteObjectIfc const &remoteObject) const =0
 Returns true if the given remote object id is added to the remoting service.
 
virtual bool isRemoteObjectAdded (int32_t const remoteObjectId) const =0
 Returns true if the given remote object id is added to the remoting service.
 
virtual bool add (RemoteObjectIfc &remoteObject)=0
 Adds a remote object.
 
virtual bool removeObject (RemoteObjectIfc &remoteObject)=0
 Removes the given remote object.
 

Protected Member Functions

 RemotingServiceIfc () noexcept=default
 
 RemotingServiceIfc (RemotingServiceIfc const &) noexcept=delete
 
 RemotingServiceIfc (RemotingServiceIfc &&) noexcept=delete
 
RemotingServiceIfcoperator= (RemotingServiceIfc const &) &noexcept=delete
 
RemotingServiceIfcoperator= (RemotingServiceIfc &&) &noexcept=delete
 

Detailed Description

Interface for the RemotingService.

Allows the registration (add and remove) of RemoteObjects.

This interface does not provide ownership on the service object.

Definition at line 19 of file RemotingServiceIfc.h.

Constructor & Destructor Documentation

◆ ~RemotingServiceIfc()

virtual imt::base::lib::remoting::RemotingServiceIfc::~RemotingServiceIfc ( )
virtualdefault

Destructor.

◆ RemotingServiceIfc() [1/3]

imt::base::lib::remoting::RemotingServiceIfc::RemotingServiceIfc ( )
protecteddefaultnoexcept

◆ RemotingServiceIfc() [2/3]

imt::base::lib::remoting::RemotingServiceIfc::RemotingServiceIfc ( RemotingServiceIfc const &  )
protecteddeletenoexcept

◆ RemotingServiceIfc() [3/3]

imt::base::lib::remoting::RemotingServiceIfc::RemotingServiceIfc ( RemotingServiceIfc &&  )
protecteddeletenoexcept

Member Function Documentation

◆ add()

virtual bool imt::base::lib::remoting::RemotingServiceIfc::add ( RemoteObjectIfc remoteObject)
pure virtual

Adds a remote object.

Parameters
remoteObjectThe remote object to add.
Returns
True if successful.

Implemented in imt::base::lib::remoting::RemotingSendService, and imt::base::lib::remoting::RemotingServiceBase.

◆ isRemoteObjectAdded() [1/2]

virtual bool imt::base::lib::remoting::RemotingServiceIfc::isRemoteObjectAdded ( int32_t const  remoteObjectId) const
pure virtual

Returns true if the given remote object id is added to the remoting service.

Parameters
remoteObjectIdId of the remote object possibly added to this remoting service.
Returns
true if the given remote object id is added to the remoting service.

Implemented in imt::base::lib::remoting::RemotingSendService, and imt::base::lib::remoting::RemotingServiceBase.

◆ isRemoteObjectAdded() [2/2]

virtual bool imt::base::lib::remoting::RemotingServiceIfc::isRemoteObjectAdded ( RemoteObjectIfc const &  remoteObject) const
pure virtual

Returns true if the given remote object id is added to the remoting service.

Parameters
remoteObjectobject of the remote object possibly added to this remoting service.
Returns
true if the given remote object id is added to the remoting service.

Implemented in imt::base::lib::remoting::RemotingSendService, and imt::base::lib::remoting::RemotingServiceBase.

◆ operator=() [1/2]

RemotingServiceIfc & imt::base::lib::remoting::RemotingServiceIfc::operator= ( RemotingServiceIfc &&  ) &
protecteddeletenoexcept

◆ operator=() [2/2]

RemotingServiceIfc & imt::base::lib::remoting::RemotingServiceIfc::operator= ( RemotingServiceIfc const &  ) &
protecteddeletenoexcept

◆ removeObject()

virtual bool imt::base::lib::remoting::RemotingServiceIfc::removeObject ( RemoteObjectIfc remoteObject)
pure virtual

Removes the given remote object.

Parameters
remoteObjectThe remote object to remove.
Returns
True if successful.

Implemented in imt::base::lib::remoting::RemotingSendService, and imt::base::lib::remoting::RemotingServiceBase.


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