Dataflow Runtime API  3.0.3.0
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[], const uint32_t bufferSize)
 Constructor. More...
 
virtual ~RemotingSendService (void)
 Destructor. More...
 
virtual uint32_t getMaxTransferSize (void) const
 
virtual bool send (const int32_t remoteObjectId)
 
void setDataSender (DataSenderIfc &dataSender)
 Sets the DataSender. More...
 
DataSenderIfc * getDataSender (void)
 Gets the DataSender. More...
 
virtual bool isRemoteObjectAdded (const RemoteObjectIfc &remoteObject) const
 
virtual bool isRemoteObjectAdded (const int32_t 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 (void) 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 (void)
 Destructor. More...
 
- Public Member Functions inherited from imt::base::lib::remoting::RemotingSendServiceIfc
virtual ~RemotingSendServiceIfc (void)
 Destructor. More...
 

Additional Inherited Members

- Protected Member Functions inherited from imt::base::lib::remoting::RemotingServiceBase
bool getRemoteObject (const int32_t 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[],
const uint32_t  bufferSize 
)
explicit

Constructor.

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

◆ ~RemotingSendService()

virtual imt::base::lib::remoting::RemotingSendService::~RemotingSendService ( void  )
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 ( void  )

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 ( void  ) const
virtual

◆ isRemoteObjectAdded() [1/2]

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

◆ isRemoteObjectAdded() [2/2]

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

◆ removeObject()

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

◆ send()

virtual bool imt::base::lib::remoting::RemotingSendService::send ( const int32_t  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: