Snapdragon® Telematics Application Framework (TelAF) Interface Specification
|
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 } |
#define IFGEN_TAF_SOMEIPCLNT_PROTOCOL_ID "d9c015e6bad9bed32e3e8f4990694429" |
#define IFGEN_TAF_SOMEIPCLNT_MSG_SIZE 17426 |
typedef struct taf_someipClnt_Service* taf_someipClnt_ServiceRef_t |
Reference to a SOME/IP client-service-instance.
typedef struct taf_someipClnt_TxMsg* taf_someipClnt_TxMsgRef_t |
Reference to a SOME/IP request message.
typedef struct taf_someipClnt_StateChangeHandler* taf_someipClnt_StateChangeHandlerRef_t |
Reference type used by Add/Remove functions for EVENT 'taf_someipClnt_StateChange'
typedef struct taf_someipClnt_EventMsgHandler* taf_someipClnt_EventMsgHandlerRef_t |
Reference type used by Add/Remove functions for EVENT 'taf_someipClnt_EventMsg'
typedef void(* taf_someipClnt_StateChangeHandlerFunc_t) (taf_someipClnt_ServiceRef_t serviceRef, taf_someipClnt_State_t state, void *contextPtr) |
Handler for the service state change.
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.
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.
LE_SHARED bool ifgen_taf_someipClnt_HasLocalBinding | ( | void | ) |
Get if this client bound locally.
LE_SHARED void ifgen_taf_someipClnt_InitCommonData | ( | void | ) |
Init data that is common across all threads
LE_SHARED void ifgen_taf_someipClnt_CleanupCommonData | ( | le_msg_SessionRef_t | _ifgen_sessionRef | ) |
Cleanup the data of a session
LE_SHARED le_result_t ifgen_taf_someipClnt_OpenSession | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
bool | isBlocking | ||
) |
Perform common initialization and open a session
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.
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.
[in] | ifName | Network interface name. |
[out] | clientIdPtr | SOME/IP Client ID. |
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.
[in] | serviceId | Service ID. |
[in] | instanceId | Instance ID. |
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.
[in] | serviceId | Service ID. |
[in] | instanceId | Instance ID. |
[in] | ifName | Network interface name. |
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.
[in] | serviceRef | Service Reference. |
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.
[in] | serviceRef | Service Reference. |
[out] | statePtr | Service State. |
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.
[in] | serviceRef | Service Reference. |
[out] | majVerPtr | Major Version. |
[out] | minVerPtr | Minor Version. |
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.
[in] | serviceRef | Service Reference. |
[in] | handlerPtr | |
[in] | contextPtr |
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'
[in] | 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 | ||
) |
Creates a request message and sets the destination.
[in] | serviceRef | Service Reference. |
[in] | methodId | Method ID. |
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.
[in] | msgRef | Tx message reference. |
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.
[in] | msgRef | Tx message reference. |
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.
[in] | msgRef | Tx message reference. |
[in] | timeOut | Timeout in milliseconds. |
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.
[in] | msgRef | Tx message reference. |
[in] | dataPtr | Payload data. |
[in] | dataSize |
LE_SHARED le_result_t ifgen_taf_someipClnt_DeleteMsg | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_someipClnt_TxMsgRef_t | msgRef | ||
) |
Deletes a request message.
[in] | msgRef | Tx message reference. |
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.
[in] | msgRef | Tx message reference. |
[in] | handlerPtr | Response message handler. |
[in] | 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 | ||
) |
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.
[in] | serviceRef | Service Reference. |
[in] | eventGroupId | Event Group ID. |
[in] | eventId | Event ID. |
[in] | eventType | Event Type. |
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.
[in] | serviceRef | Service Reference. |
[in] | eventGroupId | Event Group ID. |
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.
[in] | serviceRef | Service Reference. |
[in] | eventGroupId | Event Group ID. |
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.
[in] | serviceRef | Service Reference. |
[in] | eventGroupId | Event Group ID. |
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.
[in] | serviceRef | Service Reference. |
[in] | eventGroupId | Event Group ID. |
[in] | handlerPtr | Event Handler. |
[in] | contextPtr |
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'
[in] | handlerRef |