adtf::devicetb::sdk::someip::key::ISomeIpDecoder Class Reference

More...

#include <someip_coder_intf.h>

Inheritance diagram for adtf::devicetb::sdk::someip::key::ISomeIpDecoder:

Collaboration diagram for adtf::devicetb::sdk::someip::key::ISomeIpDecoder:

Public Types
using	tOutputCallback = adtf::ucom::ifunction_ptr<void(const adtf::ucom::iobject_ptr<const adtf::streaming::ISample>& pSample)>
using	tErrorCallback = adtf::ucom::ifunction_ptr<void(const tResult& oResult, const adtf::ucom::iobject_ptr<const adtf::streaming::ISample>& pSample)>

Public Member Functions
	ADTF_IID (ISomeIpDecoder, "someip_decoder.key.someip.sdk.devicetb.adtf.iid")
	Interface ID for the SOME/IP coder interface.
virtual tResult	SetOutputHandler (const tOutputCallback &fnOutputCallback)=0
virtual tResult	SetErrorHandler (const tErrorCallback &fnErrorCallback)=0
virtual tResult	GarbageCollection (adtf::base::flash::tNanoSeconds tmTreshold)=0
virtual tResult	TimeReset ()=0
Public Member Functions inherited from adtf::devicetb::sdk::someip::hood::ISomeIpDecoder
	ADTF_IID (ISomeIpDecoder, "someip_decoder.hood.someip.sdk.devicetb.adtf.iid")
	Interface ID for the SOME/IP coder interface.
virtual tResult	GetDatabase (adtf::ucom::ant::iobject_ptr< const ISomeIpDatabase > &pDataBase) const =0
virtual tResult	GetPayloadDescription (const uint32_t nMessageId, adtf::base::IString &&strMDDefinitions, adtf::base::IString &&strMDStruct) const =0
virtual tResult	ProcessInputSample (const adtf::ucom::iobject_ptr< const adtf::streaming::ISample > &pSample)=0
virtual tResult	FetchOutputSample (adtf::ucom::iobject_ptr< adtf::streaming::ISample > &pSample)=0
virtual tResult	EnableDecoding (uint32_t nMessageId, bool bEnable=true)=0

Detailed Description

The ISomeIpCoder interface provides convenient access to the contents of a SOME/IP sample. This includes the sample header and the individual pdu payload.

Member Function Documentation

GarbageCollection()

virtual tResult adtf::devicetb::sdk::someip::key::ISomeIpDecoder::GarbageCollection ( adtf::base::flash::tNanoSeconds tmTreshold )

pure virtual

Invalidate the SOME/IP TP reassembly cache. Discarded fragments are reported via error handler, if set.

Parameters

tmTreshold

Discard all incomplete fragments older than tmTreshold.

Returns

tResult

SetErrorHandler()

virtual tResult adtf::devicetb::sdk::someip::key::ISomeIpDecoder::SetErrorHandler ( const tErrorCallback & fnErrorCallback )

pure virtual

Set a callback for non-critical decoding errors. When the callback is enabled, ISomeIpDecoder will no longer log messages on its own.

Parameters

[in]

fnErrorCallback

Callback for each error. Optionally references an ISample in which the error was detected. oResult == ERR_NOT_FOUND indicates database mismatch. oResult == ERR_IO_INCOMPLETE indicates SOME/IP TP faults. All other error codes indicate bitstream level corruptions.

Returns

tResult

SetOutputHandler()

virtual tResult adtf::devicetb::sdk::someip::key::ISomeIpDecoder::SetOutputHandler ( const tOutputCallback & fnOutputCallback )

pure virtual

Set a callbackfor output sample. When the callback is enabled, FetchOutputSample will no longer return any samples.

Parameters

[in]

fnOutputCallback

Callback to be called on each output sample.

Returns

tResult

TimeReset()

virtual tResult adtf::devicetb::sdk::someip::key::ISomeIpDecoder::TimeReset ( )

pure virtual

Invalidate the SOME/IP TP reassembly cache. All fragments are discarded silently.

Returns

tResult

---

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

• include/sdk/someip_coder_intf.h