imt::base::lib::remoting::RemoteObjectIfc Class Reference

Classes that implement this interface provide a generic mechanism to exchange data with a remoting peer. More...

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

Inheritance diagram for imt::base::lib::remoting::RemoteObjectIfc:

Public Member Functions
virtual int32_t	getUniqueId () const =0
	Gets the unique id of this remote object.
virtual bool	send ()=0
	Sends this remote object.
virtual void	onReceive (::imt::base::core::serialization::Deserializer &buffer)=0
	Will be called when data has been received.
virtual void	attach (int32_t const uniqueId)=0
	Attaches this remote object to remoting service.
virtual void	detach ()=0
	Detaches this remote object from remoting service.
Public Member Functions inherited from imt::base::core::serialization::SerializableIfc
virtual void	deserialize (Deserializer &buffer)=0
	Deserialize this object from the given deserialize.
virtual void	serialize (Serializer &buffer) const =0
	Serialize this object into the given serializer.

Static Public Attributes
static constexpr int32_t	UNDEFINED_ID {-1}
	ID to indicate no or an invalid remote object.

Protected Member Functions
	RemoteObjectIfc () noexcept=default
	RemoteObjectIfc (RemoteObjectIfc const &) noexcept=default
	RemoteObjectIfc (RemoteObjectIfc &&) noexcept=default
	~RemoteObjectIfc () noexcept=default
RemoteObjectIfc &	operator= (RemoteObjectIfc const &) &noexcept=default
RemoteObjectIfc &	operator= (RemoteObjectIfc &&) &noexcept=default
Protected Member Functions inherited from imt::base::core::serialization::SerializableIfc
	SerializableIfc () noexcept=default
	SerializableIfc (SerializableIfc const &) noexcept=default
	SerializableIfc (SerializableIfc &&) noexcept=default
	~SerializableIfc () noexcept=default
SerializableIfc &	operator= (SerializableIfc const &) &noexcept=default
SerializableIfc &	operator= (SerializableIfc &&) &noexcept=default

Detailed Description

Classes that implement this interface provide a generic mechanism to exchange data with a remoting peer.

Each RemoteObjectIfc implementation has a unique id, that is inserted in the byte stream sent to the remoting peer, that allows to identify the responsible remote object on the other side. The data send / received is handled in the serialize and deserialize methods.

This interface can be used to keep ownership of a remote object and delete it at the end of its lifetime.

Definition at line 25 of file RemoteObjectIfc.h.

Constructor & Destructor Documentation

RemoteObjectIfc() [1/3]

imt::base::lib::remoting::RemoteObjectIfc::RemoteObjectIfc ( )

protecteddefaultnoexcept

RemoteObjectIfc() [2/3]

imt::base::lib::remoting::RemoteObjectIfc::RemoteObjectIfc ( RemoteObjectIfc const &  )

protecteddefaultnoexcept

RemoteObjectIfc() [3/3]

imt::base::lib::remoting::RemoteObjectIfc::RemoteObjectIfc ( RemoteObjectIfc &&  )

protecteddefaultnoexcept

~RemoteObjectIfc()

imt::base::lib::remoting::RemoteObjectIfc::~RemoteObjectIfc ( )

protecteddefaultnoexcept

Member Function Documentation

attach()

virtual void imt::base::lib::remoting::RemoteObjectIfc::attach ( int32_t const  uniqueId )

pure virtual

Attaches this remote object to remoting service.

When attaching this object, a unique id must be provided.

Parameters

uniqueId

A unique for this remote object

Implemented in imt::base::lib::remoting::RemoteObjectAbs.

detach()

virtual void imt::base::lib::remoting::RemoteObjectIfc::detach ( )

pure virtual

Detaches this remote object from remoting service.

Implemented in imt::base::lib::remoting::RemoteObjectAbs.

getUniqueId()

virtual int32_t imt::base::lib::remoting::RemoteObjectIfc::getUniqueId ( ) const

pure virtual

Gets the unique id of this remote object.

Returns

unique id of this remote object

Implemented in imt::base::lib::remoting::RemoteObjectAbs.

onReceive()

virtual void imt::base::lib::remoting::RemoteObjectIfc::onReceive ( ::imt::base::core::serialization::Deserializer &  buffer )

pure virtual

Will be called when data has been received.

Parameters

buffer

The deserialize containing the data

Implemented in imt::base::lib::remoting::RemoteObjectAbs.

operator=() [1/2]

RemoteObjectIfc & imt::base::lib::remoting::RemoteObjectIfc::operator= ( RemoteObjectIfc &&  ) &

protecteddefaultnoexcept

operator=() [2/2]

RemoteObjectIfc & imt::base::lib::remoting::RemoteObjectIfc::operator= ( RemoteObjectIfc const &  ) &

protecteddefaultnoexcept

send()

virtual bool imt::base::lib::remoting::RemoteObjectIfc::send ( )

pure virtual

Sends this remote object.

Returns

bool True if send succeeded, false otherwise

Implemented in imt::base::lib::remoting::RemoteObjectAbs.

Member Data Documentation

UNDEFINED_ID

constexpr int32_t imt::base::lib::remoting::RemoteObjectIfc::UNDEFINED_ID {-1}

staticconstexpr

ID to indicate no or an invalid remote object.

Definition at line 32 of file RemoteObjectIfc.h.

---

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

• C:/src/imt/Imt.Base-cpp/Imt.Base/Imt.Base.Lib.Remoting/inc/Imt.Base.Lib.Remoting/RemoteObjectIfc.h