Dataflow Runtime API  4.0.1.0
Public Member Functions | Protected Member Functions | List of all members
imt::base::lib::remoting::RemoteObjectAbs Class Reference

Provides an abstract base class for all remote object implementations. More...

#include <Imt.Base.Lib.Remoting/RemoteObjectAbs.h>

Inheritance diagram for imt::base::lib::remoting::RemoteObjectAbs:
imt::base::lib::remoting::RemoteObjectIfc imt::base::core::serialization::SerializableIfc imt::base::lib::remoting::RemoteObjectCallbackTemplate< ProtocolType, PROTOCOL_ID > imt::base::lib::remoting::RemoteObjectSignalTemplate< PROTOCOL_ID > imt::base::lib::remoting::RemoteObjectTemplate< ProtocolType, PROTOCOL_ID >

Public Member Functions

 RemoteObjectAbs (int32_t const uniqueIdToAttach, RemotingSendServiceIfc *const pRemotingSendService=nullptr, RemotingServiceIfc *const pRemotingReceiveService=nullptr)
 Constructor. More...
 
virtual ~RemoteObjectAbs ()
 Destructor. More...
 
virtual int32_t getUniqueId () const
 
virtual bool send ()
 
virtual void onReceive (::imt::base::core::serialization::Deserializer &deserializer)
 
virtual void attach (int32_t const uniqueId)
 
virtual void detach ()
 
- Public Member Functions inherited from imt::base::lib::remoting::RemoteObjectIfc
virtual ~RemoteObjectIfc ()
 Destructor. More...
 
- Public Member Functions inherited from imt::base::core::serialization::SerializableIfc
virtual ~SerializableIfc ()
 Destructor. More...
 
virtual void deserialize (Deserializer &deserializer)=0
 Deserialize this object from the given deserializer. More...
 
virtual void serialize (Serializer &serializer) const =0
 Serialize this object into the given serializer. More...
 

Protected Member Functions

virtual uint32_t getMaxTransferSize () const
 Gets the maximum number of bytes that can be transfered by one transmission. More...
 

Additional Inherited Members

- Public Types inherited from imt::base::lib::remoting::RemoteObjectIfc
enum  { UNDEFINED_ID = -1 }
 

Detailed Description

Provides an abstract base class for all remote object implementations.

The user of this class only has to override the methods serialize and deserialize (

See also
SerializableIfc).

Constructor & Destructor Documentation

◆ RemoteObjectAbs()

imt::base::lib::remoting::RemoteObjectAbs::RemoteObjectAbs ( int32_t const  uniqueIdToAttach,
RemotingSendServiceIfc *const  pRemotingSendService = nullptr,
RemotingServiceIfc *const  pRemotingReceiveService = nullptr 
)
explicit

Constructor.

Attaches itself automatically at the remotingService if a valid Id is passed and the service is not nullptr.

Parameters
uniqueIdToAttachUnique ID to attach to RemotingService
pRemotingSendServiceThe sending service to which this object will be attached
pRemotingReceiveServiceThe receiving service to which this object will be attached

◆ ~RemoteObjectAbs()

virtual imt::base::lib::remoting::RemoteObjectAbs::~RemoteObjectAbs ( )
virtual

Destructor.

Member Function Documentation

◆ attach()

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

◆ detach()

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

◆ getMaxTransferSize()

virtual uint32_t imt::base::lib::remoting::RemoteObjectAbs::getMaxTransferSize ( ) const
protectedvirtual

Gets the maximum number of bytes that can be transfered by one transmission.

Returns
Returns the maximum number of bytes that can be transfered by one transmission

◆ getUniqueId()

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

◆ onReceive()

virtual void imt::base::lib::remoting::RemoteObjectAbs::onReceive ( ::imt::base::core::serialization::Deserializer deserializer)
virtual

◆ send()

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

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