Snapdragon® Telematics Application Framework (TelAF) Interface Specification
taf_someipClnt_common.h File Reference
#include "legato.h"
#include "taf_someipDef_common.h"

Go to the source code of this file.

Macros

#define IFGEN_TAF_SOMEIPCLNT_PROTOCOL_ID   "d9c015e6bad9bed32e3e8f4990694429"
 
#define IFGEN_TAF_SOMEIPCLNT_MSG_SIZE   17426
 

Typedefs

typedef struct taf_someipClnt_Service * taf_someipClnt_ServiceRef_t
 
typedef struct taf_someipClnt_TxMsg * taf_someipClnt_TxMsgRef_t
 
typedef struct taf_someipClnt_StateChangeHandler * taf_someipClnt_StateChangeHandlerRef_t
 
typedef struct taf_someipClnt_EventMsgHandler * taf_someipClnt_EventMsgHandlerRef_t
 
typedef void(* taf_someipClnt_StateChangeHandlerFunc_t) (taf_someipClnt_ServiceRef_t serviceRef, taf_someipClnt_State_t state, void *contextPtr)
 
typedef void(* taf_someipClnt_RespMsgHandlerFunc_t) (le_result_t result, bool isErrRsp, uint8_t returnCode, const uint8_t *dataPtr, size_t dataSize, void *contextPtr)
 
typedef void(* taf_someipClnt_EventMsgHandlerFunc_t) (taf_someipClnt_ServiceRef_t serviceRef, uint16_t eventId, const uint8_t *dataPtr, size_t dataSize, void *contextPtr)
 

Enumerations

enum  taf_someipClnt_State_t { TAF_SOMEIPCLNT_UNAVAILABLE = 0, TAF_SOMEIPCLNT_AVAILABLE = 1 }
 

Functions

LE_SHARED bool ifgen_taf_someipClnt_HasLocalBinding (void)
 
LE_SHARED void ifgen_taf_someipClnt_InitCommonData (void)
 
LE_SHARED void ifgen_taf_someipClnt_CleanupCommonData (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_someipClnt_OpenSession (le_msg_SessionRef_t _ifgen_sessionRef, bool isBlocking)
 
LE_SHARED uint16_t ifgen_taf_someipClnt_GetClientId (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_someipClnt_GetClientIdEx (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL ifName, uint16_t *clientIdPtr)
 
LE_SHARED taf_someipClnt_ServiceRef_t ifgen_taf_someipClnt_RequestService (le_msg_SessionRef_t _ifgen_sessionRef, uint16_t serviceId, uint16_t instanceId)
 
LE_SHARED taf_someipClnt_ServiceRef_t ifgen_taf_someipClnt_RequestServiceEx (le_msg_SessionRef_t _ifgen_sessionRef, uint16_t serviceId, uint16_t instanceId, const char *LE_NONNULL ifName)
 
LE_SHARED le_result_t ifgen_taf_someipClnt_ReleaseService (le_msg_SessionRef_t _ifgen_sessionRef, taf_someipClnt_ServiceRef_t serviceRef)
 
LE_SHARED le_result_t ifgen_taf_someipClnt_GetState (le_msg_SessionRef_t _ifgen_sessionRef, taf_someipClnt_ServiceRef_t serviceRef, taf_someipClnt_State_t *statePtr)
 
LE_SHARED le_result_t ifgen_taf_someipClnt_GetVersion (le_msg_SessionRef_t _ifgen_sessionRef, taf_someipClnt_ServiceRef_t serviceRef, uint8_t *majVerPtr, uint32_t *minVerPtr)
 
LE_SHARED taf_someipClnt_StateChangeHandlerRef_t ifgen_taf_someipClnt_AddStateChangeHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_someipClnt_ServiceRef_t serviceRef, taf_someipClnt_StateChangeHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED void ifgen_taf_someipClnt_RemoveStateChangeHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_someipClnt_StateChangeHandlerRef_t handlerRef)
 
LE_SHARED taf_someipClnt_TxMsgRef_t ifgen_taf_someipClnt_CreateMsg (le_msg_SessionRef_t _ifgen_sessionRef, taf_someipClnt_ServiceRef_t serviceRef, uint16_t methodId)
 
LE_SHARED le_result_t ifgen_taf_someipClnt_SetNonRet (le_msg_SessionRef_t _ifgen_sessionRef, taf_someipClnt_TxMsgRef_t msgRef)
 
LE_SHARED le_result_t ifgen_taf_someipClnt_SetReliable (le_msg_SessionRef_t _ifgen_sessionRef, taf_someipClnt_TxMsgRef_t msgRef)
 
LE_SHARED le_result_t ifgen_taf_someipClnt_SetTimeout (le_msg_SessionRef_t _ifgen_sessionRef, taf_someipClnt_TxMsgRef_t msgRef, uint32_t timeOut)
 
LE_SHARED le_result_t ifgen_taf_someipClnt_SetPayload (le_msg_SessionRef_t _ifgen_sessionRef, taf_someipClnt_TxMsgRef_t msgRef, const uint8_t *dataPtr, size_t dataSize)
 
LE_SHARED le_result_t ifgen_taf_someipClnt_DeleteMsg (le_msg_SessionRef_t _ifgen_sessionRef, taf_someipClnt_TxMsgRef_t msgRef)
 
LE_SHARED void ifgen_taf_someipClnt_RequestResponse (le_msg_SessionRef_t _ifgen_sessionRef, taf_someipClnt_TxMsgRef_t msgRef, taf_someipClnt_RespMsgHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED le_result_t ifgen_taf_someipClnt_EnableEventGroup (le_msg_SessionRef_t _ifgen_sessionRef, taf_someipClnt_ServiceRef_t serviceRef, uint16_t eventGroupId, uint16_t eventId, taf_someipDef_EventType_t eventType)
 
LE_SHARED le_result_t ifgen_taf_someipClnt_DisableEventGroup (le_msg_SessionRef_t _ifgen_sessionRef, taf_someipClnt_ServiceRef_t serviceRef, uint16_t eventGroupId)
 
LE_SHARED le_result_t ifgen_taf_someipClnt_SubscribeEventGroup (le_msg_SessionRef_t _ifgen_sessionRef, taf_someipClnt_ServiceRef_t serviceRef, uint16_t eventGroupId)
 
LE_SHARED le_result_t ifgen_taf_someipClnt_UnsubscribeEventGroup (le_msg_SessionRef_t _ifgen_sessionRef, taf_someipClnt_ServiceRef_t serviceRef, uint16_t eventGroupId)
 
LE_SHARED taf_someipClnt_EventMsgHandlerRef_t ifgen_taf_someipClnt_AddEventMsgHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_someipClnt_ServiceRef_t serviceRef, uint16_t eventGroupId, taf_someipClnt_EventMsgHandlerFunc_t handlerPtr, void *contextPtr)
 
LE_SHARED void ifgen_taf_someipClnt_RemoveEventMsgHandler (le_msg_SessionRef_t _ifgen_sessionRef, taf_someipClnt_EventMsgHandlerRef_t handlerRef)
 

Macro Definition Documentation

◆ IFGEN_TAF_SOMEIPCLNT_PROTOCOL_ID

#define IFGEN_TAF_SOMEIPCLNT_PROTOCOL_ID   "d9c015e6bad9bed32e3e8f4990694429"

◆ IFGEN_TAF_SOMEIPCLNT_MSG_SIZE

#define IFGEN_TAF_SOMEIPCLNT_MSG_SIZE   17426

Typedef Documentation

◆ taf_someipClnt_ServiceRef_t

typedef struct taf_someipClnt_Service* taf_someipClnt_ServiceRef_t

Reference to a SOME/IP client-service-instance.

◆ taf_someipClnt_TxMsgRef_t

typedef struct taf_someipClnt_TxMsg* taf_someipClnt_TxMsgRef_t

Reference to a SOME/IP request message.

◆ taf_someipClnt_StateChangeHandlerRef_t

typedef struct taf_someipClnt_StateChangeHandler* taf_someipClnt_StateChangeHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'taf_someipClnt_StateChange'

◆ taf_someipClnt_EventMsgHandlerRef_t

typedef struct taf_someipClnt_EventMsgHandler* taf_someipClnt_EventMsgHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'taf_someipClnt_EventMsg'

◆ taf_someipClnt_StateChangeHandlerFunc_t

typedef void(* taf_someipClnt_StateChangeHandlerFunc_t) (taf_someipClnt_ServiceRef_t serviceRef, taf_someipClnt_State_t state, void *contextPtr)

Handler for the service state change.

◆ taf_someipClnt_RespMsgHandlerFunc_t

typedef void(* taf_someipClnt_RespMsgHandlerFunc_t) (le_result_t result, bool isErrRsp, uint8_t returnCode, const uint8_t *dataPtr, size_t dataSize, void *contextPtr)

The asynchronous response handler for RequestResponse(). If "result" is not LE_OK, other input parameters can be ignored.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid input parameters for RequestResponse().
  • LE_NOT_PERMITTED – The message is not created by the client.
  • LE_UNAVAILABLE – Service is not available.
  • LE_TIMEOUT – Response time outs.

◆ taf_someipClnt_EventMsgHandlerFunc_t

typedef void(* taf_someipClnt_EventMsgHandlerFunc_t) (taf_someipClnt_ServiceRef_t serviceRef, uint16_t eventId, const uint8_t *dataPtr, size_t dataSize, void *contextPtr)

Handler for an event message.

Enumeration Type Documentation

◆ taf_someipClnt_State_t

Service state.

Enumerator
TAF_SOMEIPCLNT_UNAVAILABLE 

Service is unavailable.

TAF_SOMEIPCLNT_AVAILABLE 

Service is available.

Function Documentation

◆ ifgen_taf_someipClnt_HasLocalBinding()

LE_SHARED bool ifgen_taf_someipClnt_HasLocalBinding ( void  )

Get if this client bound locally.

◆ ifgen_taf_someipClnt_InitCommonData()

LE_SHARED void ifgen_taf_someipClnt_InitCommonData ( void  )

Init data that is common across all threads

◆ ifgen_taf_someipClnt_CleanupCommonData()

LE_SHARED void ifgen_taf_someipClnt_CleanupCommonData ( le_msg_SessionRef_t  _ifgen_sessionRef)

Cleanup the data of a session

◆ ifgen_taf_someipClnt_OpenSession()

LE_SHARED le_result_t ifgen_taf_someipClnt_OpenSession ( le_msg_SessionRef_t  _ifgen_sessionRef,
bool  isBlocking 
)

Perform common initialization and open a session

◆ ifgen_taf_someipClnt_GetClientId()

LE_SHARED uint16_t ifgen_taf_someipClnt_GetClientId ( le_msg_SessionRef_t  _ifgen_sessionRef)

Gets the SOME/IP client ID of client-service-instance on default network interface.

Returns
  • Client ID.

◆ ifgen_taf_someipClnt_GetClientIdEx()

LE_SHARED le_result_t ifgen_taf_someipClnt_GetClientIdEx ( le_msg_SessionRef_t  _ifgen_sessionRef,
const char *LE_NONNULL  ifName,
uint16_t *  clientIdPtr 
)

Gets the SOME/IP client ID of client-service-instance on a dedicated network interface. The ifName shall match the device name specified in one of the JSON files.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid parameters.
  • LE_NOT_FOUND – Client ID is not found.
Parameters
[in]ifNameNetwork interface name.
[out]clientIdPtrSOME/IP Client ID.

◆ ifgen_taf_someipClnt_RequestService()

LE_SHARED taf_someipClnt_ServiceRef_t ifgen_taf_someipClnt_RequestService ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint16_t  serviceId,
uint16_t  instanceId 
)

Requests a client-service-instance on default network interface and returns the reference to the client-service-instance.

Returns
  • Reference to the client-service-instance.
  • NULL if invalid parameters.
Parameters
[in]serviceIdService ID.
[in]instanceIdInstance ID.

◆ ifgen_taf_someipClnt_RequestServiceEx()

LE_SHARED taf_someipClnt_ServiceRef_t ifgen_taf_someipClnt_RequestServiceEx ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint16_t  serviceId,
uint16_t  instanceId,
const char *LE_NONNULL  ifName 
)

Requests a client-service-instance on a dedicated network interface and returns the reference to the client-service-instance. The ifName shall match the device name specified in one of the JSON files.

Returns
  • Reference to the client-service-instance.
  • NULL if invalid parameters.
Parameters
[in]serviceIdService ID.
[in]instanceIdInstance ID.
[in]ifNameNetwork interface name.

◆ ifgen_taf_someipClnt_ReleaseService()

LE_SHARED le_result_t ifgen_taf_someipClnt_ReleaseService ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_someipClnt_ServiceRef_t  serviceRef 
)

Releases a client-service-instance.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid parameters.
  • LE_NOT_PERMITTED – The service is not requested by the client.
  • LE_BUSY – The service still has active handlers or pending requests.
Parameters
[in]serviceRefService Reference.

◆ ifgen_taf_someipClnt_GetState()

LE_SHARED le_result_t ifgen_taf_someipClnt_GetState ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_someipClnt_ServiceRef_t  serviceRef,
taf_someipClnt_State_t statePtr 
)

Gets the service state.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid parameters.
  • LE_NOT_PERMITTED – The service is not requested by the client.
Parameters
[in]serviceRefService Reference.
[out]statePtrService State.

◆ ifgen_taf_someipClnt_GetVersion()

LE_SHARED le_result_t ifgen_taf_someipClnt_GetVersion ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_someipClnt_ServiceRef_t  serviceRef,
uint8_t *  majVerPtr,
uint32_t *  minVerPtr 
)

Gets the service version.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid parameters.
  • LE_NOT_PERMITTED – The service is not requested by the client.
  • LE_UNAVAILABLE – Service is unavailable.
Parameters
[in]serviceRefService Reference.
[out]majVerPtrMajor Version.
[out]minVerPtrMinor Version.

◆ ifgen_taf_someipClnt_AddStateChangeHandler()

LE_SHARED taf_someipClnt_StateChangeHandlerRef_t ifgen_taf_someipClnt_AddStateChangeHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_someipClnt_ServiceRef_t  serviceRef,
taf_someipClnt_StateChangeHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Add handler function for EVENT 'taf_someipClnt_StateChange'

This event provides information on the service state change.

Parameters
[in]serviceRefService Reference.
[in]handlerPtr
[in]contextPtr

◆ ifgen_taf_someipClnt_RemoveStateChangeHandler()

LE_SHARED void ifgen_taf_someipClnt_RemoveStateChangeHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_someipClnt_StateChangeHandlerRef_t  handlerRef 
)

Remove handler function for EVENT 'taf_someipClnt_StateChange'

Parameters
[in]handlerRef

◆ ifgen_taf_someipClnt_CreateMsg()

LE_SHARED taf_someipClnt_TxMsgRef_t ifgen_taf_someipClnt_CreateMsg ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_someipClnt_ServiceRef_t  serviceRef,
uint16_t  methodId 
)

Creates a request message and sets the destination.

Returns
  • Reference to the request message.
  • NULL if invalid parameters.
Parameters
[in]serviceRefService Reference.
[in]methodIdMethod ID.

◆ ifgen_taf_someipClnt_SetNonRet()

LE_SHARED le_result_t ifgen_taf_someipClnt_SetNonRet ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_someipClnt_TxMsgRef_t  msgRef 
)

Sets the request to a non-return-request(MT_REQUEST_NO_RETURN). By default, it is MT_REQUEST.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid input parameters.
  • LE_NOT_PERMITTED – The message is not created by the client.
Parameters
[in]msgRefTx message reference.

◆ ifgen_taf_someipClnt_SetReliable()

LE_SHARED le_result_t ifgen_taf_someipClnt_SetReliable ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_someipClnt_TxMsgRef_t  msgRef 
)

Uses TCP to send the request. By default, it uses UDP.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid input parameters.
  • LE_NOT_PERMITTED – The message is not created by the client.
Parameters
[in]msgRefTx message reference.

◆ ifgen_taf_someipClnt_SetTimeout()

LE_SHARED le_result_t ifgen_taf_someipClnt_SetTimeout ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_someipClnt_TxMsgRef_t  msgRef,
uint32_t  timeOut 
)

Sets the timeout in milliseconds for waiting for the response. By default, the timeout is 30000 ms. 0 means NEVER time out.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid input parameters.
  • LE_NOT_PERMITTED – The message is not created by the client.
Parameters
[in]msgRefTx message reference.
[in]timeOutTimeout in milliseconds.

◆ ifgen_taf_someipClnt_SetPayload()

LE_SHARED le_result_t ifgen_taf_someipClnt_SetPayload ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_someipClnt_TxMsgRef_t  msgRef,
const uint8_t *  dataPtr,
size_t  dataSize 
)

Sets the payload data of the request. By default, the payload is empty.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid input parameters.
  • LE_NOT_PERMITTED – The message is not created by the client.
Parameters
[in]msgRefTx message reference.
[in]dataPtrPayload data.
[in]dataSize

◆ ifgen_taf_someipClnt_DeleteMsg()

LE_SHARED le_result_t ifgen_taf_someipClnt_DeleteMsg ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_someipClnt_TxMsgRef_t  msgRef 
)

Deletes a request message.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid input parameters.
  • LE_NOT_PERMITTED – The message is not created by the client.
Parameters
[in]msgRefTx message reference.

◆ ifgen_taf_someipClnt_RequestResponse()

LE_SHARED void ifgen_taf_someipClnt_RequestResponse ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_someipClnt_TxMsgRef_t  msgRef,
taf_someipClnt_RespMsgHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Sends an asynchronous request message. The response handler will be called once the response is received or any errors occur.

NOTE: The request message will be automatically deleted after calling this API.

Parameters
[in]msgRefTx message reference.
[in]handlerPtrResponse message handler.
[in]contextPtr

◆ ifgen_taf_someipClnt_EnableEventGroup()

LE_SHARED le_result_t ifgen_taf_someipClnt_EnableEventGroup ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_someipClnt_ServiceRef_t  serviceRef,
uint16_t  eventGroupId,
uint16_t  eventId,
taf_someipDef_EventType_t  eventType 
)

Enables an event group by adding an event into the group.

NOTE: This API can be called multiple times if there is more than one event to be added into the group. Currently, one event can only be added into one group, and one event group can be enabled only by one client.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid input parameters.
  • LE_NOT_PERMITTED – The service is not requested by the client, or the event group is subscribed or enabled by another client, or the event is already added into another group.
  • LE_DUPLICATE – The event is already in this group.
Parameters
[in]serviceRefService Reference.
[in]eventGroupIdEvent Group ID.
[in]eventIdEvent ID.
[in]eventTypeEvent Type.

◆ ifgen_taf_someipClnt_DisableEventGroup()

LE_SHARED le_result_t ifgen_taf_someipClnt_DisableEventGroup ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_someipClnt_ServiceRef_t  serviceRef,
uint16_t  eventGroupId 
)

Disables an event group and removes all events from the group.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid input parameters.
  • LE_NOT_PERMITTED – The service is not requested by the client, or the event group is subscribed or already enabled by another client.
  • LE_DUPLICATE – The event group is not enabled.
Parameters
[in]serviceRefService Reference.
[in]eventGroupIdEvent Group ID.

◆ ifgen_taf_someipClnt_SubscribeEventGroup()

LE_SHARED le_result_t ifgen_taf_someipClnt_SubscribeEventGroup ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_someipClnt_ServiceRef_t  serviceRef,
uint16_t  eventGroupId 
)

Subscribes an event group of a service.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid input parameters.
  • LE_NOT_PERMITTED – The service is not requested by the client, or the event group is not enabled or already enabled by another client.
  • LE_DUPLICATE – The event group is already subscribed.
Parameters
[in]serviceRefService Reference.
[in]eventGroupIdEvent Group ID.

◆ ifgen_taf_someipClnt_UnsubscribeEventGroup()

LE_SHARED le_result_t ifgen_taf_someipClnt_UnsubscribeEventGroup ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_someipClnt_ServiceRef_t  serviceRef,
uint16_t  eventGroupId 
)

Unsubscribes an event group of a service.

Returns
  • LE_OK – Succeeded.
  • LE_BAD_PARAMETER – Invalid input parameters.
  • LE_NOT_PERMITTED – The service is not requested by the client, or the event group is not enabled or already enabled by another client.
  • LE_DUPLICATE – The event group is not subscribed.
Parameters
[in]serviceRefService Reference.
[in]eventGroupIdEvent Group ID.

◆ ifgen_taf_someipClnt_AddEventMsgHandler()

LE_SHARED taf_someipClnt_EventMsgHandlerRef_t ifgen_taf_someipClnt_AddEventMsgHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_someipClnt_ServiceRef_t  serviceRef,
uint16_t  eventGroupId,
taf_someipClnt_EventMsgHandlerFunc_t  handlerPtr,
void *  contextPtr 
)

Add handler function for EVENT 'taf_someipClnt_EventMsg'

This event provides information on an event message.

Parameters
[in]serviceRefService Reference.
[in]eventGroupIdEvent Group ID.
[in]handlerPtrEvent Handler.
[in]contextPtr

◆ ifgen_taf_someipClnt_RemoveEventMsgHandler()

LE_SHARED void ifgen_taf_someipClnt_RemoveEventMsgHandler ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_someipClnt_EventMsgHandlerRef_t  handlerRef 
)

Remove handler function for EVENT 'taf_someipClnt_EventMsg'

Parameters
[in]handlerRef