Dataflow Runtime API  4.0.1.0
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
imt::base::lib::remoting::RemotingSendService Class Reference

Service for remote objects to send data to another remote object. More...

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

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

Public Member Functions

 RemotingSendService (uint8_t pSendBuffer[], uint32_t const bufferSize)
 Constructor. More...
 
virtual ~RemotingSendService ()
 Destructor. More...
 
virtual uint32_t getMaxTransferSize () const
 
virtual bool send (int32_t const remoteObjectId)
 
void setDataSender (DataSenderIfc &dataSender)
 Sets the DataSender. More...
 
DataSenderIfcgetDataSender ()
 Gets the DataSender. More...
 
virtual bool isRemoteObjectAdded (RemoteObjectIfc const &remoteObject) const
 
virtual bool isRemoteObjectAdded (int32_t const remoteObjectId) const
 
virtual bool add (RemoteObjectIfc &remoteObject)
 
virtual bool removeObject (RemoteObjectIfc &remoteObject)
 
- Public Member Functions inherited from imt::base::lib::remoting::RemotingServiceBase
 RemotingServiceBase ()
 Constructor. More...
 
virtual ~RemotingServiceBase ()
 Destructor. More...
 
uint32_t getRemoteObjectCount () const
 Returns the count of remote objects that have been added to the remoting service. More...
 
- Public Member Functions inherited from imt::base::lib::remoting::RemotingServiceIfc
virtual ~RemotingServiceIfc ()
 Destructor. More...
 
- Public Member Functions inherited from imt::base::lib::remoting::RemotingSendServiceIfc
virtual ~RemotingSendServiceIfc ()
 Destructor. More...
 

Additional Inherited Members

- Protected Member Functions inherited from imt::base::lib::remoting::RemotingServiceBase
bool getRemoteObject (int32_t const remoteObjectId, RemoteObjectIfc *&pRemoteObject) const
 Get the remote object by Id. More...
 

Detailed Description

Service for remote objects to send data to another remote object.

Constructor & Destructor Documentation

◆ RemotingSendService()

imt::base::lib::remoting::RemotingSendService::RemotingSendService ( uint8_t  pSendBuffer[],
uint32_t const  bufferSize 
)
explicit

Constructor.

Parameters
pSendBufferBuffer for elements to send.
bufferSizeSize of the buffer.

◆ ~RemotingSendService()

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

Destructor.

Member Function Documentation

◆ add()

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

◆ getDataSender()

DataSenderIfc* imt::base::lib::remoting::RemotingSendService::getDataSender ( )

Gets the DataSender.

May be null if setDataSender() has not been called yet.

Returns
Pointer to the DataSender.

◆ getMaxTransferSize()

virtual uint32_t imt::base::lib::remoting::RemotingSendService::getMaxTransferSize ( ) const
virtual

◆ isRemoteObjectAdded() [1/2]

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

◆ isRemoteObjectAdded() [2/2]

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

◆ removeObject()

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

◆ send()

virtual bool imt::base::lib::remoting::RemotingSendService::send ( int32_t const  remoteObjectId)
virtual

◆ setDataSender()

void imt::base::lib::remoting::RemotingSendService::setDataSender ( DataSenderIfc dataSender)

Sets the DataSender.

This instance will be responsible to really send the data.

Parameters
dataSenderThe data sender to set.

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