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

This layer checks incoming data frames for crc errors. More...

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

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

Public Member Functions

 DataFrameCRC16CheckReceiveLayer (DataReceiverIfc &upperLevelReceiver, CRC16CheckFailedCallbackIfc &crc16CheckFailedCallback)
 Constructor. More...
 
virtual ~DataFrameCRC16CheckReceiveLayer (void)
 Destructor. More...
 
virtual void onDataReceived (const uint8_t *const pData, const uint32_t countDataBytes)
 
void setInitialCrcValue (const uint16_t initialCrcValue)
 Set the initial CRC value to increase robustness of CRC-16 checksum. More...
 
- Public Member Functions inherited from imt::base::lib::remoting::DataReceiverIfc
virtual ~DataReceiverIfc (void)
 Destructor. More...
 

Detailed Description

This layer checks incoming data frames for crc errors.

Constructor & Destructor Documentation

◆ DataFrameCRC16CheckReceiveLayer()

imt::base::lib::remoting::DataFrameCRC16CheckReceiveLayer::DataFrameCRC16CheckReceiveLayer ( DataReceiverIfc upperLevelReceiver,
CRC16CheckFailedCallbackIfc crc16CheckFailedCallback 
)
explicit

Constructor.

Parameters
upperLevelReceiverInterface to the next higher receiver layer.
crc16CheckFailedCallbackCallback if CRC check is failed.

◆ ~DataFrameCRC16CheckReceiveLayer()

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

Destructor.

Member Function Documentation

◆ onDataReceived()

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

◆ setInitialCrcValue()

void imt::base::lib::remoting::DataFrameCRC16CheckReceiveLayer::setInitialCrcValue ( const uint16_t  initialCrcValue)

Set the initial CRC value to increase robustness of CRC-16 checksum.

Older implementations used a default value of 0, which is the least robust. Recommendation: use 0xFFFF as initial value.

Parameters
initialCrcValueInitial value for the CRC-16 checksum calculation.

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