imt::base::lib::remoting::RemotingSendService Class Reference

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

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

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

Public Member Functions
	RemotingSendService (uint8_t pSendBuffer[], uint32_t const bufferSize)
	Constructor.
uint32_t	getMaxTransferSize () const final
bool	send (int32_t const remoteObjectId) final
void	setDataSender (DataSenderIfc &dataSender)
	Sets the DataSender.
DataSenderIfc *	getDataSender ()
	Gets the DataSender.
bool	isRemoteObjectAdded (RemoteObjectIfc const &remoteObject) const final
bool	isRemoteObjectAdded (int32_t const remoteObjectId) const final
bool	add (RemoteObjectIfc &remoteObject) final
bool	removeObject (RemoteObjectIfc &remoteObject) final
virtual bool	send (int32_t const remoteObjectId)=0
	Sends the remote object with the given id.
virtual uint32_t	getMaxTransferSize () const =0
	Return the buffer size.
Public Member Functions inherited from imt::base::lib::remoting::RemotingServiceIfc
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.
Public Member Functions inherited from imt::base::lib::remoting::RemotingServiceBase
	RemotingServiceBase ()
	Constructor.
bool	isRemoteObjectAdded (RemoteObjectIfc const &remoteObject) const override
bool	isRemoteObjectAdded (int32_t const remoteObjectId) const override
bool	add (RemoteObjectIfc &remoteObject) override
bool	removeObject (RemoteObjectIfc &remoteObject) override
uint32_t	getRemoteObjectCount () const
	Returns the count of remote objects that have been added to the remoting service.

Additional Inherited Members
Protected Member Functions inherited from imt::base::lib::remoting::RemotingSendServiceIfc
	RemotingSendServiceIfc () noexcept=default
	Default constructor.
Protected Member Functions inherited from imt::base::lib::remoting::RemotingServiceIfc
	RemotingServiceIfc () noexcept=default
	RemotingServiceIfc (RemotingServiceIfc const &) noexcept=delete
	RemotingServiceIfc (RemotingServiceIfc &&) noexcept=delete
RemotingServiceIfc &	operator= (RemotingServiceIfc const &) &noexcept=delete
RemotingServiceIfc &	operator= (RemotingServiceIfc &&) &noexcept=delete
Protected Member Functions inherited from imt::base::lib::remoting::RemotingServiceBase
RemoteObjectIfc *	getRemoteObject (int32_t const remoteObjectId) const
	Get the remote object by Id.

Detailed Description

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

Definition at line 33 of file RemotingSendService.h.

Constructor & Destructor Documentation

RemotingSendService()

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

Constructor.

Parameters

pSendBuffer	Buffer for elements to send.
bufferSize	Size of the buffer.

Member Function Documentation

add()

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

finalvirtual

See also

RemotingServiceIfc

Implements imt::base::lib::remoting::RemotingServiceIfc.

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()

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

finalvirtual

See also

RemotingSendServiceIfc

Implements imt::base::lib::remoting::RemotingSendServiceIfc.

isRemoteObjectAdded() [1/2]

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

finalvirtual

See also

RemotingServiceIfc

Implements imt::base::lib::remoting::RemotingServiceIfc.

isRemoteObjectAdded() [2/2]

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

finalvirtual

See also

RemotingServiceIfc

Implements imt::base::lib::remoting::RemotingServiceIfc.

removeObject()

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

finalvirtual

See also

RemotingServiceIfc

Implements imt::base::lib::remoting::RemotingServiceIfc.

send()

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

finalvirtual

See also

RemotingSendServiceIfc

Implements imt::base::lib::remoting::RemotingSendServiceIfc.

setDataSender()

void imt::base::lib::remoting::RemotingSendService::setDataSender

(

DataSenderIfc &

dataSender

)

Sets the DataSender.

This instance will be responsible to really send the data.

Parameters

dataSender

The data sender to set.

---

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/RemotingSendService.h