imt::base::lib::remoting::DataSenderIfc Class Reference

Inteface for a sender that can be called to send byte data. More...

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

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

Public Member Functions
	DataSenderIfc (DataSenderIfc const &)=delete
	DataSenderIfc (DataSenderIfc &&)=delete
DataSenderIfc &	operator= (DataSenderIfc const &) &=delete
DataSenderIfc &	operator= (DataSenderIfc &&) &=delete
virtual bool	sendData (uint8_t const pData[], uint32_t const countDataBytes)=0
	Send data.
virtual void	onTransmissionComplete ()=0
	Called on a completed transmission.
virtual void	onTransmissionError ()=0
	Called on a transmission error.

Protected Member Functions
	DataSenderIfc () noexcept=default
	Default constructor.
	~DataSenderIfc () noexcept=default
	Destructor.

Detailed Description

Inteface for a sender that can be called to send byte data.

This interface does not provide ownership on the sender object.

Definition at line 18 of file DataSenderIfc.h.

Constructor & Destructor Documentation

DataSenderIfc() [1/3]

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

delete

DataSenderIfc() [2/3]

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

delete

DataSenderIfc() [3/3]

imt::base::lib::remoting::DataSenderIfc::DataSenderIfc ( )

protecteddefaultnoexcept

Default constructor.

~DataSenderIfc()

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

protecteddefaultnoexcept

Destructor.

Member Function Documentation

onTransmissionComplete()

virtual void imt::base::lib::remoting::DataSenderIfc::onTransmissionComplete ( )

pure virtual

Called on a completed transmission.

Implemented in imt::base::lib::remoting::DataFrameCRC16CheckSendLayer, and imt::base::lib::remoting::DataFrameSyncSendLayer.

onTransmissionError()

virtual void imt::base::lib::remoting::DataSenderIfc::onTransmissionError ( )

pure virtual

Called on a transmission error.

Implemented in imt::base::lib::remoting::DataFrameCRC16CheckSendLayer, and imt::base::lib::remoting::DataFrameSyncSendLayer.

operator=() [1/2]

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

delete

operator=() [2/2]

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

delete

sendData()

virtual bool imt::base::lib::remoting::DataSenderIfc::sendData ( uint8_t const  pData[], uint32_t const  countDataBytes  )

pure virtual

Send data.

Parameters

pData	Data to send.
countDataBytes	Number of data bytes to send.

Returns

True if send succeeded, false otherwise.

Implemented in imt::base::lib::remoting::DataFrameCRC16CheckSendLayer, and imt::base::lib::remoting::DataFrameSyncSendLayer.

---

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