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

#include <someip_database_intf.h>

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

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

Public Member Functions
	ADTF_IID (ISomeIpDatabase, "someip_database.key.someip.sdk.devicetb.adtf.iid")
	Interface ID for the SOME/IP database interface.
virtual tResult	GetMessageInfo (const adtf::devicetb::sdk::someip::hood::tSomeIpSampleHeader &oSampleHeader, const adtf::devicetb::sdk::someip::hood::tSomeIpMessageHeader &oMessageHeader, const void *pMessageData, size_t nMessageDataSize, const adtf::devicetb::sdk::someip::hood::tSomeIpMessageInfo *&pMessageInfo) const =0
virtual tResult	GetMessageInfo (const adtf::devicetb::sdk::someip::hood::tSomeIpSampleHeader &oSampleHeader, const adtf::devicetb::sdk::someip::hood::tSomeIpMessageHeader &oMessageHeader, const adtf::devicetb::sdk::someip::hood::tSomeIpMessageInfo *&pMessageInfo) const=0
virtual tResult	GetMessageInfo (uint32_t nMessageInfoId, const adtf::devicetb::sdk::someip::hood::tSomeIpMessageInfo *&pMessageInfo) const=0
Public Member Functions inherited from adtf::devicetb::sdk::someip::hood::ISomeIpDatabase
	ADTF_IID (ISomeIpDatabase, "someip_database.hood.someip.sdk.devicetb.adtf.iid")
	Interface ID for the SOME/IP database interface.
virtual tResult	GetClusterInfos (const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tClusterInfo *pClusterInfo) > &fnCallback) const =0
virtual tResult	GetEcus (const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tECUInfo *pECUInfo) > &fnCallback) const =0
virtual tResult	GetChannelsByCluster (uint32_t nClusterId, const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tChannelInfo *pChannelInfo) > &fnCallback) const =0
virtual tResult	GetCluster (uint32_t nClusterId, const adtf::devicetb::sdk::someip::hood::tClusterInfo *&pClusterInfo) const =0
virtual tResult	GetEcu (uint32_t nEcuId, const adtf::devicetb::sdk::someip::hood::tECUInfo *&pECUInfo) const =0
virtual tResult	GetChannel (uint32_t nChannelId, const adtf::devicetb::sdk::someip::hood::tChannelInfo *&pChannelInfo) const =0
virtual tResult	GetSenderEcu (const tSomeIpSampleHeader &oSampleHeader, const adtf::devicetb::sdk::someip::hood::tECUInfo *pECUInfo) const =0
virtual tResult	GetConnectionsByEcu (uint32_t nEcuId, const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tSomeIpConnectionInfo *pSocketInfo) > &fnCallback) const =0
virtual tResult	GetConnectionsByChannel (uint32_t nChannelId, const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tSomeIpConnectionInfo *pSocketInfo) > &fnCallback) const =0
virtual tResult	GetMessageInfos (const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tSomeIpMessageInfo *pMessageInfo) > &fnCallback) const =0
virtual bool	ConnectionContainsSomeIp (const adtf::devicetb::sdk::someip::hood::tSomeIpSampleHeader &oEthernetHeader) const =0

Detailed Description

The ISomeIpDatabase interface provides access to SOME/IP specific information contained in a database file such as FIBEX or ARXML.

Member Function Documentation

GetMessageInfo() [1/3]

virtual tResult adtf::devicetb::sdk::someip::hood::ISomeIpDatabase::GetMessageInfo ( const adtf::devicetb::sdk::someip::hood::tSomeIpSampleHeader & oSampleHeader, const adtf::devicetb::sdk::someip::hood::tSomeIpMessageHeader & oMessageHeader, const adtf::devicetb::sdk::someip::hood::tSomeIpMessageInfo *& pMessageInfo ) const

virtual

Returns the SOME/IP Message Info for a given SOME/IP message sample and message header.

Parameters

[in]	oSampleHeader	The SOME/IP Sample Header.
[in]	oMessageHeader	The header of the SOME/IP message.
[out]	pMessageInfo	The message info of the SOME/IP message. Ownership of pMessageInfo remains with ISomeIpDatabase and has the same lifetime as ISomeIpDatabase.

Returns

tResult

Implements adtf::devicetb::sdk::someip::hood::ISomeIpDatabase.

GetMessageInfo() [2/3]

virtual tResult adtf::devicetb::sdk::someip::key::ISomeIpDatabase::GetMessageInfo ( const adtf::devicetb::sdk::someip::hood::tSomeIpSampleHeader & oSampleHeader, const adtf::devicetb::sdk::someip::hood::tSomeIpMessageHeader & oMessageHeader, const void * pMessageData, size_t nMessageDataSize, const adtf::devicetb::sdk::someip::hood::tSomeIpMessageInfo *& pMessageInfo ) const

pure virtual

Returns the SOME/IP Message Info for a given SOME/IP message sample and message header.

Parameters

[in]	oSampleHeader	The SOME/IP Sample Header.
[in]	oMessageHeader	The message header of the SOME/IP message.
[in]	pMessageData	The payload of the SOME/IP message. Required for the SOME/IP request header in the first 8 bytes.
[in]	nMessageDataSize	The accessible size of pMessageData. Needs to be at least 8 bytes when the message is true SOME/IP.
[out]	pMessageInfo	The message info of the SOME/IP message. Ownership of pMessageInfo remains with ISomeIpDatabase and has the same lifetime as ISomeIpDatabase.

Returns

tResult

GetMessageInfo() [3/3]

virtual tResult adtf::devicetb::sdk::someip::hood::ISomeIpDatabase::GetMessageInfo ( uint32_t nMessageInfoId, const adtf::devicetb::sdk::someip::hood::tSomeIpMessageInfo *& pMessageInfo ) const

virtual

Getter for a tSomeIpMessageInfo with a given Id.

Parameters

[in]	nMessageInfoId	The Id of the message.
[out]	pMessageInfo	The Info of the Message. Ownership of pMessageInfo remains with ISomeIpDatabase and has the same lifetime as ISomeIpDatabase.

Returns

tResult

Implements adtf::devicetb::sdk::someip::hood::ISomeIpDatabase.

---

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

• include/sdk/someip_database_intf.h