Dataflow Runtime API  3.1.1.0
Public Member Functions | List of all members
imt::base::lib::remoting::DataFrameSyncSendLayer Class Reference

This layer appends frame end chars to mark the the end of a data frame. More...

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

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

Public Member Functions

 DataFrameSyncSendLayer (DataSenderIfc &lowerLevelSender, const uint8_t frameEndCharacter=static_cast< uint8_t >('~'))
 Constructor. More...
 
virtual ~DataFrameSyncSendLayer (void)
 Destructor. More...
 
virtual bool sendData (const uint8_t pData[], const uint32_t countDataBytes)
 
virtual void onTransmissionComplete (void)
 
virtual void onTransmissionError (void)
 
- Public Member Functions inherited from imt::base::lib::remoting::DataSenderIfc
virtual ~DataSenderIfc (void)
 Destructor. More...
 

Detailed Description

This layer appends frame end chars to mark the the end of a data frame.

Characters in the user data that conflict with the special characters used for frame end marking are escaped. The technique used to ommit conflicts of the special characters with the user data is often referenced as byte stuffing or character stuffing.

Constructor & Destructor Documentation

◆ DataFrameSyncSendLayer()

imt::base::lib::remoting::DataFrameSyncSendLayer::DataFrameSyncSendLayer ( DataSenderIfc lowerLevelSender,
const uint8_t  frameEndCharacter = static_cast< uint8_t >('~') 
)
explicit

Constructor.

Parameters
lowerLevelSenderInterface to the next lower sender layer
frameEndCharacteroptional frame end character, default is '~'.

◆ ~DataFrameSyncSendLayer()

virtual imt::base::lib::remoting::DataFrameSyncSendLayer::~DataFrameSyncSendLayer ( void  )
virtual

Destructor.

Member Function Documentation

◆ onTransmissionComplete()

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

◆ onTransmissionError()

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

◆ sendData()

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

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