ADTF_DEVICE_TOOLBOX  3.12.1 (ADTF 3.18.3)
ISomeIpDatabaseabstract

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

Inheritance diagram for ISomeIpDatabase:
[legend]

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
 Returns the SOME/IP Message Info for a given SOME/IP message sample and message header. More...
 
- Public Member Functions inherited from ISomeIpDatabase
 ADTF_IID (ISomeIpDatabase, "someip_database.hood.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 adtf::devicetb::sdk::someip::hood::tSomeIpMessageInfo *&pMessageInfo) const =0
 Returns the SOME/IP Message Info for a given SOME/IP message sample and message header. More...
 
virtual tResult GetClusterInfos (const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tClusterInfo *pClusterInfo) > &fnCallback) const =0
 Returns all Cluster Infos. More...
 
virtual tResult GetEcus (const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tECUInfo *pECUInfo) > &fnCallback) const =0
 Returns all Ecu Infos from a cluster. More...
 
virtual tResult GetChannelsByCluster (uint32_t nClusterId, const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tChannelInfo *pChannelInfo) > &fnCallback) const =0
 Returns all Channel Infos from a cluster. More...
 
virtual tResult GetCluster (uint32_t nClusterId, const adtf::devicetb::sdk::someip::hood::tClusterInfo *&pClusterInfo) const =0
 Getter for a tClusterInfo with a given Id. More...
 
virtual tResult GetEcu (uint32_t nEcuId, const adtf::devicetb::sdk::someip::hood::tECUInfo *&pECUInfo) const =0
 Getter for a tEcuInfo with a given Id. More...
 
virtual tResult GetChannel (uint32_t nChannelId, const adtf::devicetb::sdk::someip::hood::tChannelInfo *&pChannelInfo) const =0
 Getter for a tChannelInfo with a given Id. More...
 
virtual tResult GetSenderEcu (const tSomeIpSampleHeader &oSampleHeader, const adtf::devicetb::sdk::someip::hood::tECUInfo *pECUInfo) const =0
 Getter for the sender ECU. More...
 
virtual tResult GetMessageInfo (uint32_t nMessageInfoId, const adtf::devicetb::sdk::someip::hood::tSomeIpMessageInfo *&pMessageInfo) const =0
 Getter for a tSomeIpMessageInfo with a given Id. More...
 
virtual tResult GetConnectionsByEcu (uint32_t nEcuId, const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tSomeIpConnectionInfo *pSocketInfo) > &fnCallback) const =0
 Getter for the sockets connected with an ecu. More...
 
virtual tResult GetConnectionsByChannel (uint32_t nChannelId, const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tSomeIpConnectionInfo *pSocketInfo) > &fnCallback) const =0
 Getter for the sockets connected with a channel. More...
 
virtual tResult GetMessageInfos (const ucom::nitro::ifunction< void(const adtf::devicetb::sdk::someip::hood::tSomeIpMessageInfo *pMessageInfo) > &fnCallback) const =0
 Getter for all SOME/IP messages. More...
 
virtual bool ConnectionContainsSomeIp (const adtf::devicetb::sdk::someip::hood::tSomeIpSampleHeader &oEthernetHeader) const =0
 Check if a given ethernet sample is on a connection handled by this database. More...
 

Detailed Description

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

Definition at line 189 of file someip_database_intf.h.

Member Function Documentation

◆ GetMessageInfo()

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
pure virtual

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

Parameters
[in]oSampleHeaderThe SOME/IP Sample Header.
[in]oMessageHeaderThe message header of the SOME/IP message.
[in]pMessageDataThe payload of the SOME/IP message. Required for the SOME/IP request header in the first 8 bytes.
[in]nMessageDataSizeThe accessible size of pMessageData. Needs to be at least 8 bytes when the message is true SOME/IP.
[out]pMessageInfoThe message info of the SOME/IP message. Ownership of pMessageInfo remains with ISomeIpDatabase and has the same lifetime as ISomeIpDatabase.
Returns
tResult