taf_someipClnt_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_SOMEIPCLNT_INTERFACE_H_INCLUDE_GUARD
#define TAF_SOMEIPCLNT_INTERFACE_H_INCLUDE_GUARD


#include "legato.h"

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

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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_someipClnt_ConnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipClnt_TryConnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_FULL_API void taf_someipClnt_SetServerDisconnectHandler
(
    taf_someipClnt_DisconnectHandler_t disconnectHandler,
    void *contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_FULL_API void taf_someipClnt_SetNonExitServerDisconnectHandler
(
    taf_someipClnt_DisconnectHandler_t disconnectHandler,
    void *contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_someipClnt_DisconnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
uint16_t taf_someipClnt_GetClientId
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipClnt_GetClientIdEx
(
    const char* LE_NONNULL ifName,
    uint16_t* clientIdPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_someipClnt_ServiceRef_t taf_someipClnt_RequestService
(
    uint16_t serviceId,
    uint16_t instanceId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_someipClnt_ServiceRef_t taf_someipClnt_RequestServiceEx
(
    uint16_t serviceId,
    uint16_t instanceId,
    const char* LE_NONNULL ifName
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipClnt_ReleaseService
(
    taf_someipClnt_ServiceRef_t serviceRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipClnt_GetState
(
    taf_someipClnt_ServiceRef_t serviceRef,
    taf_someipClnt_State_t* statePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipClnt_GetVersion
(
    taf_someipClnt_ServiceRef_t serviceRef,
    uint8_t* majVerPtr,
    uint32_t* minVerPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_someipClnt_StateChangeHandlerRef_t taf_someipClnt_AddStateChangeHandler
(
    taf_someipClnt_ServiceRef_t serviceRef,
    taf_someipClnt_StateChangeHandlerFunc_t handlerPtr,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_someipClnt_RemoveStateChangeHandler
(
    taf_someipClnt_StateChangeHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_someipClnt_TxMsgRef_t taf_someipClnt_CreateMsg
(
    taf_someipClnt_ServiceRef_t serviceRef,
    uint16_t methodId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipClnt_SetNonRet
(
    taf_someipClnt_TxMsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipClnt_SetReliable
(
    taf_someipClnt_TxMsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipClnt_SetTimeout
(
    taf_someipClnt_TxMsgRef_t msgRef,
    uint32_t timeOut
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipClnt_SetPayload
(
    taf_someipClnt_TxMsgRef_t msgRef,
    const uint8_t* dataPtr,
    size_t dataSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipClnt_DeleteMsg
(
    taf_someipClnt_TxMsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_someipClnt_RequestResponse
(
    taf_someipClnt_TxMsgRef_t msgRef,
    taf_someipClnt_RespMsgHandlerFunc_t handlerPtr,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipClnt_EnableEventGroup
(
    taf_someipClnt_ServiceRef_t serviceRef,
    uint16_t eventGroupId,
    uint16_t eventId,
    taf_someipDef_EventType_t eventType
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipClnt_DisableEventGroup
(
    taf_someipClnt_ServiceRef_t serviceRef,
    uint16_t eventGroupId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipClnt_SubscribeEventGroup
(
    taf_someipClnt_ServiceRef_t serviceRef,
    uint16_t eventGroupId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_someipClnt_UnsubscribeEventGroup
(
    taf_someipClnt_ServiceRef_t serviceRef,
    uint16_t eventGroupId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_someipClnt_EventMsgHandlerRef_t taf_someipClnt_AddEventMsgHandler
(
    taf_someipClnt_ServiceRef_t serviceRef,
    uint16_t eventGroupId,
    taf_someipClnt_EventMsgHandlerFunc_t handlerPtr,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_someipClnt_RemoveEventMsgHandler
(
    taf_someipClnt_EventMsgHandlerRef_t handlerRef
);

#endif // TAF_SOMEIPCLNT_INTERFACE_H_INCLUDE_GUARD