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

This layer receives a byte stream from a lower layer and tries to generate data frames out of the byte streams data. More...

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

Inheritance diagram for imt::base::lib::remoting::DataFrameSyncReceiveLayer:
imt::base::lib::remoting::DataReceiverIfc

Public Member Functions

 DataFrameSyncReceiveLayer (DataReceiverIfc &upperLevelReceiver, const uint8_t frameEndCharacter=static_cast< uint8_t >('~'))
 Constructor. More...
 
virtual ~DataFrameSyncReceiveLayer (void)
 Destructor. More...
 
virtual void onDataReceived (const uint8_t *const pData, const uint32_t countDataBytes)
 
- Public Member Functions inherited from imt::base::lib::remoting::DataReceiverIfc
virtual ~DataReceiverIfc (void)
 Destructor. More...
 

Detailed Description

This layer receives a byte stream from a lower layer and tries to generate data frames out of the byte streams data.

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

◆ DataFrameSyncReceiveLayer()

imt::base::lib::remoting::DataFrameSyncReceiveLayer::DataFrameSyncReceiveLayer ( DataReceiverIfc upperLevelReceiver,
const uint8_t  frameEndCharacter = static_cast< uint8_t >('~') 
)
explicit

Constructor.

Parameters
upperLevelReceiverInterface to the next higher receiver layer
frameEndCharacteroptional frame end character, default is '~'.

◆ ~DataFrameSyncReceiveLayer()

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

Destructor.

Member Function Documentation

◆ onDataReceived()

virtual void imt::base::lib::remoting::DataFrameSyncReceiveLayer::onDataReceived ( const uint8_t *const  pData,
const uint32_t  countDataBytes 
)
virtual

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