someip_database_intf.h

Go to the documentation of this file.

 
#pragma once
 
#include <adtf_utils.h>
#include <adtf_ucom3.h>
#include "someip_types.h"
#include <adtfmediadescription/type_reflection.h>

constexpr const char* CID_DEVTB_SOMEIP_PARSER = "someip_database_parser.service.devicetb.cid";

constexpr const char* BUS_ID_SOMEIP = "SOME/IP";

namespace adtf
{

namespace devicetb
{

namespace sdk
{

namespace someip
{
namespace hood
{

class ISomeIpDatabase : public adtf::ucom::ant::IObject
{
public:
    ADTF_IID(ISomeIpDatabase, "someip_database.hood.someip.sdk.devicetb.adtf.iid");

    [[deprecated("Use signature from namespace key instead.")]]
    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 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 GetMessageInfo(uint32_t nMessageInfoId, const adtf::devicetb::sdk::someip::hood::tSomeIpMessageInfo*& pMessageInfo) 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;
};
 
} // namespace hood

namespace key
{
    class ISomeIpDatabase : public hood::ISomeIpDatabase
    {
    public:
        ADTF_IID(ISomeIpDatabase, "someip_database.key.someip.sdk.devicetb.adtf.iid");
 
        // 2 Parameter signature of GetMessageInfo is still valid.
        using hood::ISomeIpDatabase::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 = 0;
    };
}

using ISomeIpDatabase = key::ISomeIpDatabase;
 
 
} // namespace someip
} // namespace sdk
} // namespace devicetb
} // namespace adtf