taf_someipSvr_interface.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_INTERFACE_H_INCLUDE_GUARD
#define TAF_SOMEIPSVR_INTERFACE_H_INCLUDE_GUARD


#include "legato.h"

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

// Internal includes for this interface
#include "taf_someipSvr_common.h"
//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_someipSvr_DisconnectHandler_t)(void *);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_someipSvr_ConnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipSvr_TryConnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_FULL_API void taf_someipSvr_SetServerDisconnectHandler
(
    taf_someipSvr_DisconnectHandler_t disconnectHandler,
    void *contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_FULL_API void taf_someipSvr_SetNonExitServerDisconnectHandler
(
    taf_someipSvr_DisconnectHandler_t disconnectHandler,
    void *contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_someipSvr_DisconnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_someipSvr_ServiceRef_t taf_someipSvr_GetService
(
    uint16_t serviceId,
    uint16_t instanceId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_someipSvr_ServiceRef_t taf_someipSvr_GetServiceEx
(
    uint16_t serviceId,
    uint16_t instanceId,
    const char* LE_NONNULL ifName
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipSvr_SetServiceVersion
(
    taf_someipSvr_ServiceRef_t serviceRef,
    uint8_t majVer,
    uint32_t minVer
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipSvr_SetServicePort
(
    taf_someipSvr_ServiceRef_t serviceRef,
    uint16_t udpPort,
    uint16_t tcpPort,
    bool enableMagicCookies
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipSvr_OfferService
(
    taf_someipSvr_ServiceRef_t serviceRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipSvr_StopOfferService
(
    taf_someipSvr_ServiceRef_t serviceRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipSvr_EnableEvent
(
    taf_someipSvr_ServiceRef_t serviceRef,
    uint16_t eventId,
    uint16_t eventgroupId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipSvr_SetEventType
(
    taf_someipSvr_ServiceRef_t serviceRef,
    uint16_t eventId,
    taf_someipDef_EventType_t eventType
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipSvr_SetEventCycleTime
(
    taf_someipSvr_ServiceRef_t serviceRef,
    uint16_t eventId,
    uint32_t cycleTime
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipSvr_DisableEvent
(
    taf_someipSvr_ServiceRef_t serviceRef,
    uint16_t eventId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipSvr_OfferEvent
(
    taf_someipSvr_ServiceRef_t serviceRef,
    uint16_t eventId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipSvr_StopOfferEvent
(
    taf_someipSvr_ServiceRef_t serviceRef,
    uint16_t eventId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipSvr_Notify
(
    taf_someipSvr_ServiceRef_t serviceRef,
    uint16_t eventId,
    const uint8_t* dataPtr,
    size_t dataSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_someipSvr_RxMsgHandlerRef_t taf_someipSvr_AddRxMsgHandler
(
    taf_someipSvr_ServiceRef_t serviceRef,
    taf_someipSvr_RxMsgHandlerFunc_t handlerPtr,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_someipSvr_RemoveRxMsgHandler
(
    taf_someipSvr_RxMsgHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_someipSvr_SubscriptionHandlerRef_t taf_someipSvr_AddSubscriptionHandler
(
    taf_someipSvr_ServiceRef_t serviceRef,
    uint16_t eventGroupId,
    taf_someipSvr_SubscriptionHandlerFunc_t handlerPtr,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_someipSvr_RemoveSubscriptionHandler
(
    taf_someipSvr_SubscriptionHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipSvr_GetServiceId
(
    taf_someipSvr_RxMsgRef_t msgRef,
    uint16_t* serviceIdPtr,
    uint16_t* instanceIdPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipSvr_GetMethodId
(
    taf_someipSvr_RxMsgRef_t msgRef,
    uint16_t* methodIdPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipSvr_GetClientId
(
    taf_someipSvr_RxMsgRef_t msgRef,
    uint16_t* clientIdPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipSvr_GetMsgType
(
    taf_someipSvr_RxMsgRef_t msgRef,
    uint8_t* msgTypePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipSvr_GetPayloadSize
(
    taf_someipSvr_RxMsgRef_t msgRef,
    uint32_t* payloadSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipSvr_GetPayloadData
(
    taf_someipSvr_RxMsgRef_t msgRef,
    uint8_t* dataPtr,
    size_t* dataSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipSvr_SendResponse
(
    taf_someipSvr_RxMsgRef_t msgRef,
    bool isErrRsp,
    uint8_t returnCode,
    const uint8_t* dataPtr,
    size_t dataSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipSvr_ReleaseRxMsg
(
    taf_someipSvr_RxMsgRef_t msgRef
);

#endif // TAF_SOMEIPSVR_INTERFACE_H_INCLUDE_GUARD