taf_someipSvr_common.h

Go to the documentation of this file.

/*
 * ====================== WARNING ======================
 *
 * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
 * DO NOT MODIFY IN ANY WAY.
 *
 * ====================== WARNING ======================
 */
#ifndef TAF_SOMEIPSVR_COMMON_H_INCLUDE_GUARD
#define TAF_SOMEIPSVR_COMMON_H_INCLUDE_GUARD


#include "legato.h"

// Interface specific includes
#include "taf_someipDef_common.h"

#define IFGEN_TAF_SOMEIPSVR_PROTOCOL_ID "f7d78ee6d1f97efc26c5c23d07e1a60b"
#define IFGEN_TAF_SOMEIPSVR_MSG_SIZE 17426



//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_someipSvr_Service* taf_someipSvr_ServiceRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_someipSvr_RxMsg* taf_someipSvr_RxMsgRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_someipSvr_RxMsgHandler* taf_someipSvr_RxMsgHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_someipSvr_SubscriptionHandler* taf_someipSvr_SubscriptionHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_someipSvr_RxMsgHandlerFunc_t)
(
        taf_someipSvr_RxMsgRef_t msgRef,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_someipSvr_SubscriptionHandlerFunc_t)
(
        taf_someipSvr_ServiceRef_t serviceRef,
        uint16_t eventGroupId,
        bool isSubscribed,
        void* contextPtr
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED bool ifgen_taf_someipSvr_HasLocalBinding
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_someipSvr_InitCommonData
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_someipSvr_CleanupCommonData
(
    le_msg_SessionRef_t _ifgen_sessionRef
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_someipSvr_OpenSession
(
    le_msg_SessionRef_t _ifgen_sessionRef,
    bool isBlocking
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_someipSvr_ServiceRef_t ifgen_taf_someipSvr_GetService
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint16_t serviceId,
        uint16_t instanceId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_someipSvr_ServiceRef_t ifgen_taf_someipSvr_GetServiceEx
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint16_t serviceId,
        uint16_t instanceId,
        const char* LE_NONNULL ifName
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_someipSvr_SetServiceVersion
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_someipSvr_ServiceRef_t serviceRef,
        uint8_t majVer,
        uint32_t minVer
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_someipSvr_SetServicePort
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_someipSvr_ServiceRef_t serviceRef,
        uint16_t udpPort,
        uint16_t tcpPort,
        bool enableMagicCookies
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_someipSvr_OfferService
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_someipSvr_ServiceRef_t serviceRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_someipSvr_StopOfferService
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_someipSvr_ServiceRef_t serviceRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_someipSvr_EnableEvent
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_someipSvr_ServiceRef_t serviceRef,
        uint16_t eventId,
        uint16_t eventgroupId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_someipSvr_SetEventType
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_someipSvr_ServiceRef_t serviceRef,
        uint16_t eventId,
        taf_someipDef_EventType_t eventType
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_someipSvr_SetEventCycleTime
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_someipSvr_ServiceRef_t serviceRef,
        uint16_t eventId,
        uint32_t cycleTime
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_someipSvr_DisableEvent
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_someipSvr_ServiceRef_t serviceRef,
        uint16_t eventId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_someipSvr_OfferEvent
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_someipSvr_ServiceRef_t serviceRef,
        uint16_t eventId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_someipSvr_StopOfferEvent
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_someipSvr_ServiceRef_t serviceRef,
        uint16_t eventId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_someipSvr_Notify
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_someipSvr_ServiceRef_t serviceRef,
        uint16_t eventId,
        const uint8_t* dataPtr,
        size_t dataSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_someipSvr_RxMsgHandlerRef_t ifgen_taf_someipSvr_AddRxMsgHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_someipSvr_ServiceRef_t serviceRef,
        taf_someipSvr_RxMsgHandlerFunc_t handlerPtr,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_someipSvr_RemoveRxMsgHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_someipSvr_RxMsgHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_someipSvr_SubscriptionHandlerRef_t ifgen_taf_someipSvr_AddSubscriptionHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_someipSvr_ServiceRef_t serviceRef,
        uint16_t eventGroupId,
        taf_someipSvr_SubscriptionHandlerFunc_t handlerPtr,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_someipSvr_RemoveSubscriptionHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_someipSvr_SubscriptionHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_someipSvr_GetServiceId
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_someipSvr_RxMsgRef_t msgRef,
        uint16_t* serviceIdPtr,
        uint16_t* instanceIdPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_someipSvr_GetMethodId
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_someipSvr_RxMsgRef_t msgRef,
        uint16_t* methodIdPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_someipSvr_GetClientId
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_someipSvr_RxMsgRef_t msgRef,
        uint16_t* clientIdPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_someipSvr_GetMsgType
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_someipSvr_RxMsgRef_t msgRef,
        uint8_t* msgTypePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_someipSvr_GetPayloadSize
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_someipSvr_RxMsgRef_t msgRef,
        uint32_t* payloadSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_someipSvr_GetPayloadData
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_someipSvr_RxMsgRef_t msgRef,
        uint8_t* dataPtr,
        size_t* dataSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_someipSvr_SendResponse
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_someipSvr_RxMsgRef_t msgRef,
        bool isErrRsp,
        uint8_t returnCode,
        const uint8_t* dataPtr,
        size_t dataSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_someipSvr_ReleaseRxMsg
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_someipSvr_RxMsgRef_t msgRef
);

#endif // TAF_SOMEIPSVR_COMMON_H_INCLUDE_GUARD