Snapdragon® Telematics Application Framework (TelAF) Interface Specification
|
Go to the source code of this file.
Macros | |
#define | IFGEN_TAF_SMS_PROTOCOL_ID "309f1ede5d1a6d7e47a5f3a2e7b5af98" |
#define | IFGEN_TAF_SMS_MSG_SIZE 193 |
#define | TAF_SMS_SMSC_ADDR_BYTES 28 |
#define | TAF_SMS_TIMESTAMP_LEN 20 |
#define | TAF_SMS_TIMESTAMP_BYTES 21 |
#define | TAF_SMS_TEXT_LEN 160 |
#define | TAF_SMS_TEXT_BYTES 161 |
#define | TAF_SMS_BINARY_BYTES 140 |
#define | TAF_SMS_UCS2_BYTES 140 |
#define | TAF_SMS_UCS2_CHARS 70 |
#define | TAF_SMS_PDU_PAYLOAD 140 |
#define | TAF_SMS_PDU_BYTES 176 |
Typedefs | |
typedef struct taf_sms_Msg * | taf_sms_MsgRef_t |
typedef struct taf_sms_MsgList * | taf_sms_MsgListRef_t |
typedef struct taf_sms_RxMsgHandler * | taf_sms_RxMsgHandlerRef_t |
typedef struct taf_sms_FullStorageEventHandler * | taf_sms_FullStorageEventHandlerRef_t |
typedef void(* | taf_sms_CallbackResultFunc_t) (taf_sms_MsgRef_t msgRef, taf_sms_SendStatus_t status, void *contextPtr) |
typedef void(* | taf_sms_RxMsgHandlerFunc_t) (taf_sms_MsgRef_t msgRef, void *contextPtr) |
typedef void(* | taf_sms_FullStorageHandlerFunc_t) (taf_sms_StorageFullType_t fullType, void *contextPtr) |
#define IFGEN_TAF_SMS_PROTOCOL_ID "309f1ede5d1a6d7e47a5f3a2e7b5af98" |
#define IFGEN_TAF_SMS_MSG_SIZE 193 |
#define TAF_SMS_SMSC_ADDR_BYTES 28 |
SMS center string, including size of address type is 3, size of special chars (quotes, comma, plus) is 4, maximum number of address and null terminator.
#define TAF_SMS_TIMESTAMP_LEN 20 |
Timestamp string length.
#define TAF_SMS_TIMESTAMP_BYTES 21 |
Timestamp string length including the null-terminator.
#define TAF_SMS_TEXT_LEN 160 |
The text message length.
#define TAF_SMS_TEXT_BYTES 161 |
The text message length including the null-terminator.
#define TAF_SMS_BINARY_BYTES 140 |
The binary message length.
#define TAF_SMS_UCS2_BYTES 140 |
The UCS2 message length.
#define TAF_SMS_UCS2_CHARS 70 |
The UCS2 message characters length.
#define TAF_SMS_PDU_PAYLOAD 140 |
The PDU payload bytes length.
#define TAF_SMS_PDU_BYTES 176 |
The PDU message length. 36 bytes header.
typedef struct taf_sms_Msg* taf_sms_MsgRef_t |
Reference type for SMS message objects.
typedef struct taf_sms_MsgList* taf_sms_MsgListRef_t |
Reference type for SMS message List.
typedef struct taf_sms_RxMsgHandler* taf_sms_RxMsgHandlerRef_t |
Reference type used by Add/Remove functions for EVENT 'taf_sms_RxMsg'
typedef struct taf_sms_FullStorageEventHandler* taf_sms_FullStorageEventHandlerRef_t |
Reference type used by Add/Remove functions for EVENT 'taf_sms_FullStorageEvent'
typedef void(* taf_sms_CallbackResultFunc_t) (taf_sms_MsgRef_t msgRef, taf_sms_SendStatus_t status, void *contextPtr) |
Handler for sending messages.
typedef void(* taf_sms_RxMsgHandlerFunc_t) (taf_sms_MsgRef_t msgRef, void *contextPtr) |
Handler for receiving messages.
typedef void(* taf_sms_FullStorageHandlerFunc_t) (taf_sms_StorageFullType_t fullType, void *contextPtr) |
Handler for full storage notifications.
enum taf_sms_Storage_t |
Full storage indication type.
To notify a client app with differet storage status, the following notifications will be sent to client with storage full indications.
When preferred storage is set as HLOS:
When preferred storage is set as NV (not supported):
When preferred storage is set as SIM:
enum taf_sms_Type_t |
enum taf_sms_ReadStatus_t |
enum taf_sms_SendStatus_t |
Send status type (for Tx message).
enum taf_sms_LockStatus_t |
enum taf_sms_Format_t |
LE_SHARED bool ifgen_taf_sms_HasLocalBinding | ( | void | ) |
Get if this client bound locally.
LE_SHARED void ifgen_taf_sms_InitCommonData | ( | void | ) |
Init data that is common across all threads
LE_SHARED void ifgen_taf_sms_CleanupCommonData | ( | le_msg_SessionRef_t | _ifgen_sessionRef | ) |
Cleanup the data of a session
LE_SHARED le_result_t ifgen_taf_sms_OpenSession | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
bool | isBlocking | ||
) |
Perform common initialization and open a session
LE_SHARED taf_sms_MsgListRef_t ifgen_taf_sms_CreateRxMsgList | ( | le_msg_SessionRef_t | _ifgen_sessionRef | ) |
Creates a message list for accessing messages.
LE_SHARED void ifgen_taf_sms_DeleteList | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgListRef_t | msgListRef | ||
) |
Deletes a message list.
[in] | msgListRef | Message list reference. |
LE_SHARED taf_sms_RxMsgHandlerRef_t ifgen_taf_sms_AddRxMsgHandler | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_RxMsgHandlerFunc_t | handlerPtr, | ||
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_sms_RxMsg'
Event for handler usage.
[in] | handlerPtr | Handler for receiving messages. |
[in] | contextPtr |
LE_SHARED void ifgen_taf_sms_RemoveRxMsgHandler | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_RxMsgHandlerRef_t | handlerRef | ||
) |
Remove handler function for EVENT 'taf_sms_RxMsg'
[in] | handlerRef |
LE_SHARED taf_sms_FullStorageEventHandlerRef_t ifgen_taf_sms_AddFullStorageEventHandler | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_FullStorageHandlerFunc_t | handlerPtr, | ||
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_sms_FullStorageEvent'
Event for information on full storage notifications.
[in] | handlerPtr | Handler for full storage indications. |
[in] | contextPtr |
LE_SHARED void ifgen_taf_sms_RemoveFullStorageEventHandler | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_FullStorageEventHandlerRef_t | handlerRef | ||
) |
Remove handler function for EVENT 'taf_sms_FullStorageEvent'
[in] | handlerRef |
LE_SHARED taf_sms_MsgRef_t ifgen_taf_sms_GetFirst | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgListRef_t | msgListRef | ||
) |
Gets the first message in the given list.
[in] | msgListRef | Message list reference. |
LE_SHARED taf_sms_MsgRef_t ifgen_taf_sms_GetNext | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgListRef_t | msgListRef | ||
) |
Gets the next message in the list.
[in] | msgListRef | Message list reference. |
LE_SHARED taf_sms_SendStatus_t ifgen_taf_sms_GetSendStatus | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef | ||
) |
Gets the message's send status.
[in] | msgRef | Message reference. |
LE_SHARED taf_sms_ReadStatus_t ifgen_taf_sms_GetReadStatus | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef | ||
) |
Gets the message's read status.
[in] | msgRef | Message reference. |
LE_SHARED taf_sms_LockStatus_t ifgen_taf_sms_GetLockStatus | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef | ||
) |
Gets the message's lock status.
[in] | msgRef | Message reference. |
LE_SHARED taf_sms_MsgRef_t ifgen_taf_sms_Create | ( | le_msg_SessionRef_t | _ifgen_sessionRef | ) |
Creates a new message to send.
LE_SHARED le_result_t ifgen_taf_sms_SetDestination | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef, | ||
const char *LE_NONNULL | dest | ||
) |
Sets the message's destination phone number.
[in] | msgRef | Message reference. |
[in] | dest | Destination number. |
LE_SHARED le_result_t ifgen_taf_sms_SetText | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef, | ||
const char *LE_NONNULL | text | ||
) |
Sets the message's text.
[in] | msgRef | Message reference. |
[in] | text | Text message. |
LE_SHARED le_result_t ifgen_taf_sms_SetBinary | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef, | ||
const uint8_t * | binPtr, | ||
size_t | binSize | ||
) |
Sets the message's binary content.
[in] | msgRef | Message reference. |
[in] | binPtr | Binary data. |
[in] | binSize |
LE_SHARED le_result_t ifgen_taf_sms_SetUCS2 | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef, | ||
const uint16_t * | ucs2Ptr, | ||
size_t | ucs2Size | ||
) |
Sets the message's UCS2 content.
[in] | msgRef | Message reference. |
[in] | ucs2Ptr | UCS2 message. |
[in] | ucs2Size |
LE_SHARED le_result_t ifgen_taf_sms_SetPDU | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef, | ||
const uint8_t * | pduPtr, | ||
size_t | pduSize | ||
) |
Sets the message's PDU format.
[in] | msgRef | Message reference. |
[in] | pduPtr | Message in PDU format. |
[in] | pduSize |
LE_SHARED le_result_t ifgen_taf_sms_SetCallback | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef, | ||
taf_sms_CallbackResultFunc_t | handlerPtr, | ||
void * | contextPtr | ||
) |
Sets the message's callback function.
[in] | msgRef | Message reference. |
[in] | handlerPtr | Handler for sending message. |
[in] | contextPtr |
LE_SHARED le_result_t ifgen_taf_sms_SetPhoneId | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef, | ||
uint8_t | phoneId | ||
) |
Sets the phone ID function for the message; phone ID must be 1 or 2 (for DSDA use case).
[in] | msgRef | Message reference. |
[in] | phoneId | Phone ID. |
LE_SHARED void ifgen_taf_sms_Delete | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef | ||
) |
Deletes a message from the message list, if there is no message list reference, it deletes the message from storage.
[in] | msgRef | Message reference. |
LE_SHARED le_result_t ifgen_taf_sms_GetPhoneId | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef, | ||
uint8_t * | phoneIdPtr | ||
) |
Gets the message's phone ID (only for the messages stored in the SIM or created by the client).
[in] | msgRef | Message reference. |
[out] | phoneIdPtr | Pointer to the stored phone ID. |
LE_SHARED le_result_t ifgen_taf_sms_GetSenderTel | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef, | ||
char * | tel, | ||
size_t | telSize | ||
) |
Gets the message sender's phone number.
[in] | msgRef | Message reference. |
[out] | tel | Buffer to store sender's number. |
[in] | telSize |
LE_SHARED le_result_t ifgen_taf_sms_GetText | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef, | ||
char * | text, | ||
size_t | textSize | ||
) |
Gets the message's text.
[in] | msgRef | Message reference. |
[out] | text | Buffer to store message text. |
[in] | textSize |
LE_SHARED le_result_t ifgen_taf_sms_GetBinary | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef, | ||
uint8_t * | binPtr, | ||
size_t * | binSizePtr | ||
) |
Gets the message's binary data.
[in] | msgRef | Message reference. |
[out] | binPtr | Buffer to store binary data. |
[in,out] | binSizePtr |
LE_SHARED le_result_t ifgen_taf_sms_GetUCS2 | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef, | ||
uint16_t * | ucs2Ptr, | ||
size_t * | ucs2SizePtr | ||
) |
Gets the message's UCS2 encoding.
[in] | msgRef | Message reference. |
[out] | ucs2Ptr | Buffer to store UCS2 characters. |
[in,out] | ucs2SizePtr |
LE_SHARED le_result_t ifgen_taf_sms_GetPDU | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef, | ||
uint8_t * | pduPtr, | ||
size_t * | pduSizePtr | ||
) |
Gets the message's PDU data.
[in] | msgRef | Message reference. |
[out] | pduPtr | Buffer to store PDU data. |
[in,out] | pduSizePtr |
LE_SHARED size_t ifgen_taf_sms_GetPDULen | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef | ||
) |
Gets the message's PDU length.
[in] | msgRef | Message reference. |
LE_SHARED taf_sms_Type_t ifgen_taf_sms_GetType | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef | ||
) |
Gets the message's type.
[in] | msgRef | Message reference. |
LE_SHARED taf_sms_Format_t ifgen_taf_sms_GetFormat | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef | ||
) |
Gets the message's format.
[in] | msgRef | Message reference. |
LE_SHARED size_t ifgen_taf_sms_GetUserdataLen | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef | ||
) |
Gets the message's text length.
[in] | msgRef | Message reference. |
LE_SHARED le_result_t ifgen_taf_sms_Send | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef | ||
) |
Send the message.
[in] | msgRef | Message reference. |
LE_SHARED le_result_t ifgen_taf_sms_DeleteFromStorage | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef | ||
) |
Deletes a message from storage.
[in] | msgRef | Message reference. |
LE_SHARED le_result_t ifgen_taf_sms_DeleteAllFromStorage | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_Storage_t | storage | ||
) |
Deletes all messages from storage.
[in] | storage |
LE_SHARED void ifgen_taf_sms_MarkRead | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef | ||
) |
Marks a message's status as read.
[in] | msgRef | Message reference. |
LE_SHARED void ifgen_taf_sms_MarkUnread | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef | ||
) |
Marks a message's status as unread.
[in] | msgRef | Message reference. |
LE_SHARED le_result_t ifgen_taf_sms_LockFromStorage | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef | ||
) |
Marks a message's lock status as locked; the message cannot be deleted from storage.
[in] | msgRef | Message reference. |
LE_SHARED le_result_t ifgen_taf_sms_UnlockFromStorage | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef | ||
) |
Marks a message's lock status as unlocked; the message can be deleted from storage.
[in] | msgRef | Message reference. |
LE_SHARED le_result_t ifgen_taf_sms_EncryptFromStorage | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_MsgRef_t | msgRef | ||
) |
Encrypts a message which is stored in HLOS.
[in] | msgRef | Message reference. |
LE_SHARED le_result_t ifgen_taf_sms_GetSmsCenterAddress | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
uint8_t | phoneId, | ||
char * | addr, | ||
size_t | addrSize | ||
) |
Gets the SMS center address for the specified phone ID.
[in] | phoneId | Phone ID. |
[out] | addr | Buffer to store SMS center address. |
[in] | addrSize |
LE_SHARED le_result_t ifgen_taf_sms_SetSmsCenterAddress | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
uint8_t | phoneId, | ||
const char *LE_NONNULL | addr | ||
) |
Sets the SMS center address for the specified phone ID.
[in] | phoneId | Phone ID. |
[in] | addr | SMS center address. |
LE_SHARED le_result_t ifgen_taf_sms_SetPreferredStorage | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_Storage_t | prefStorage | ||
) |
Sets the preferred SMS storage place.
[in] | prefStorage | Preferred storage type. |
LE_SHARED le_result_t ifgen_taf_sms_GetPreferredStorage | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
taf_sms_Storage_t * | prefStoragePtr | ||
) |
Gets the preferred SMS storage place.
[out] | prefStoragePtr | Preferred storage type. |
LE_SHARED le_result_t ifgen_taf_sms_SendPduMsg | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
const uint8_t * | dataPtrPtr, | ||
size_t | dataPtrSize, | ||
uint32_t | timeout | ||
) |
Sends a PDU message.
[in] | dataPtrPtr | Message in PDU format. |
[in] | dataPtrSize | |
[in] | timeout | Timeout value message sent. |
LE_SHARED le_result_t ifgen_taf_sms_SendPduMsgEx | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
uint8_t | phoneId, | ||
const uint8_t * | dataPtrPtr, | ||
size_t | dataPtrSize, | ||
uint32_t | timeout | ||
) |
Sends a PDU message with phone ID.
[in] | phoneId | Phone ID. |
[in] | dataPtrPtr | Message in PDU format. |
[in] | dataPtrSize | |
[in] | timeout | Timeout value message sent. |
LE_SHARED le_result_t ifgen_taf_sms_ActivateCellBroadcast | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
uint8_t | phoneId | ||
) |
Activates cell broadcast for the specified phone ID.
[in] | phoneId | Phone ID. |
LE_SHARED le_result_t ifgen_taf_sms_DeactivateCellBroadcast | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
uint8_t | phoneId | ||
) |
Deactivates cell broadcast for the specified phone ID.
[in] | phoneId | Phone ID. |
LE_SHARED le_result_t ifgen_taf_sms_AddCellBroadcastIds | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
uint8_t | phoneId, | ||
uint16_t | fromId, | ||
uint16_t | toId | ||
) |
Adds cell broadcast message range of identifier for the specified phone ID.
[in] | phoneId | Phone ID. |
[in] | fromId | Starting point of the filter. |
[in] | toId | Ending point of the filter. |
LE_SHARED le_result_t ifgen_taf_sms_RemoveCellBroadcastIds | ( | le_msg_SessionRef_t | _ifgen_sessionRef, |
uint8_t | phoneId, | ||
uint16_t | fromId, | ||
uint16_t | toId | ||
) |
Removes cell broadcast range of message identifiers for the specified phone ID.
[in] | phoneId | Phone ID. |
[in] | fromId | Starting point of the range. |
[in] | toId | Ending point of the range. |