ara::com::e2e::Profile Class Reference

E2E protection profile abstract class. More...

#include <profile.h>

Inheritance diagram for ara::com::e2e::Profile:

Public Member Functions
virtual bool	TryProtect (const std::vector< uint8_t > &unprotectedData, std::vector< uint8_t > &protectedData)=0
	Try to protect a message payload by inserting a CRC header. More...
virtual bool	TryForward (const std::vector< uint8_t > &unprotectedData, std::vector< uint8_t > &protectedData)=0
	Try to protect a message payload by inserting a CRC header while replicating the E2E status. More...
virtual CheckStatusType	Check (const std::vector< uint8_t > &protectedData)=0
	Check whether a message is received correctly or not. More...

Detailed Description

E2E protection profile abstract class.

Member Function Documentation

Check()

virtual CheckStatusType ara::com::e2e::Profile::Check ( const std::vector< uint8_t > &  protectedData )

pure virtual

Check whether a message is received correctly or not.

Parameters

protectedData

Message payload containing the CRC protection to be checked

Returns

The result of checking the message protection

Remarks

The profile internal state (e.g., counter delta) can be changed after calling the function.

Implemented in ara::com::e2e::Profile11.

TryForward()

virtual bool ara::com::e2e::Profile::TryForward ( const std::vector< uint8_t > &  unprotectedData, std::vector< uint8_t > &  protectedData  )

pure virtual

Try to protect a message payload by inserting a CRC header while replicating the E2E status.

Parameters

[in]	unprotectedData	Message payload without any protection
[out]	protectedData	Message payload containing the CRC protection

Returns

True if the protected data is generated successfully; otherwise false

Remarks

The 'protectedData' should be ignored in case of getting 'false' as the return value.

The profile internal state (e.g., counter) can be changed in case of getting 'true' as the return value.

See also

TryProtect

Implemented in ara::com::e2e::Profile11.

TryProtect()

virtual bool ara::com::e2e::Profile::TryProtect ( const std::vector< uint8_t > &  unprotectedData, std::vector< uint8_t > &  protectedData  )

pure virtual

Try to protect a message payload by inserting a CRC header.

Parameters

[in]	unprotectedData	Message payload without any protection
[out]	protectedData	Message payload containing the CRC protection

Returns

True if the protected data is generated successfully; otherwise false

Remarks

The 'protectedData' should be ignored in case of getting 'false' as the return value.

The profile internal state (e.g., counter) can be changed in case of getting 'true' as the return value.

Implemented in ara::com::e2e::Profile11.