Snapdragon® Telematics Application Framework (TelAF) Interface Specification
Data Structures | Macros | Typedefs | Enumerations | Functions
taf_appMgmt_common.h File Reference
#include "legato.h"

Go to the source code of this file.

Data Structures

struct  taf_appMgmt_AppInfo_t
 

Macros

#define IFGEN_TAF_APPMGMT_PROTOCOL_ID   "347780641c4b9919bc0664fe14d9903e"
 
#define IFGEN_TAF_APPMGMT_MSG_SIZE   268
 
#define TAF_APPMGMT_APP_NAME_BYTES   48
 
#define TAF_APPMGMT_APP_VERSION_BYTES   101
 
#define TAF_APPMGMT_APP_HASH_BYTES   101
 

Typedefs

typedef struct taf_appMgmt_AppList * taf_appMgmt_AppListRef_t
 
typedef struct taf_appMgmt_App * taf_appMgmt_AppRef_t
 

Enumerations

enum  taf_appMgmt_AppState_t { TAF_APPMGMT_STATE_STOPPED = 0, TAF_APPMGMT_STATE_STARTED = 1 }
 
enum  taf_appMgmt_AppStartMode_t { TAF_APPMGMT_START_MANUAL = 0, TAF_APPMGMT_START_AUTO = 1 }
 

Functions

LE_SHARED bool ifgen_taf_appMgmt_HasLocalBinding (void)
 
LE_SHARED void ifgen_taf_appMgmt_InitCommonData (void)
 
LE_SHARED void ifgen_taf_appMgmt_CleanupCommonData (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_appMgmt_OpenSession (le_msg_SessionRef_t _ifgen_sessionRef, bool isBlocking)
 
LE_SHARED taf_appMgmt_AppState_t ifgen_taf_appMgmt_GetState (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL appName)
 
LE_SHARED le_result_t ifgen_taf_appMgmt_GetVersion (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL appName, char *version, size_t versionSize)
 
LE_SHARED le_result_t ifgen_taf_appMgmt_Start (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL appName)
 
LE_SHARED le_result_t ifgen_taf_appMgmt_Stop (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL appName)
 
LE_SHARED le_result_t ifgen_taf_appMgmt_Uninstall (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL appName)
 
LE_SHARED taf_appMgmt_AppListRef_t ifgen_taf_appMgmt_CreateAppList (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_appMgmt_DeleteAppList (le_msg_SessionRef_t _ifgen_sessionRef, taf_appMgmt_AppListRef_t appListRef)
 
LE_SHARED taf_appMgmt_AppRef_t ifgen_taf_appMgmt_GetFirstApp (le_msg_SessionRef_t _ifgen_sessionRef, taf_appMgmt_AppListRef_t appListRef)
 
LE_SHARED taf_appMgmt_AppRef_t ifgen_taf_appMgmt_GetNextApp (le_msg_SessionRef_t _ifgen_sessionRef, taf_appMgmt_AppListRef_t appListRef)
 
LE_SHARED le_result_t ifgen_taf_appMgmt_GetAppDetails (le_msg_SessionRef_t _ifgen_sessionRef, taf_appMgmt_AppRef_t appRef, taf_appMgmt_AppInfo_t *appInfoPtr)
 

Macro Definition Documentation

◆ IFGEN_TAF_APPMGMT_PROTOCOL_ID

#define IFGEN_TAF_APPMGMT_PROTOCOL_ID   "347780641c4b9919bc0664fe14d9903e"

◆ IFGEN_TAF_APPMGMT_MSG_SIZE

#define IFGEN_TAF_APPMGMT_MSG_SIZE   268

◆ TAF_APPMGMT_APP_NAME_BYTES

#define TAF_APPMGMT_APP_NAME_BYTES   48

App name length without null characters.

◆ TAF_APPMGMT_APP_VERSION_BYTES

#define TAF_APPMGMT_APP_VERSION_BYTES   101

App version length without null characters.

◆ TAF_APPMGMT_APP_HASH_BYTES

#define TAF_APPMGMT_APP_HASH_BYTES   101

App hash length without null characters.

Typedef Documentation

◆ taf_appMgmt_AppListRef_t

typedef struct taf_appMgmt_AppList* taf_appMgmt_AppListRef_t

The reference to the app list.

◆ taf_appMgmt_AppRef_t

typedef struct taf_appMgmt_App* taf_appMgmt_AppRef_t

The reference to the app.

Enumeration Type Documentation

◆ taf_appMgmt_AppState_t

enum taf_appMgmt_AppState_t

App state enum.

Enumerator
TAF_APPMGMT_STATE_STOPPED 

App is not running.

TAF_APPMGMT_STATE_STARTED 

App is running.

◆ taf_appMgmt_AppStartMode_t

enum taf_appMgmt_AppStartMode_t

App start mode enum.

Enumerator
TAF_APPMGMT_START_MANUAL 

App started manually.

TAF_APPMGMT_START_AUTO 

App started automatically.

Function Documentation

◆ ifgen_taf_appMgmt_HasLocalBinding()

LE_SHARED bool ifgen_taf_appMgmt_HasLocalBinding ( void  )

Get if this client bound locally.

◆ ifgen_taf_appMgmt_InitCommonData()

LE_SHARED void ifgen_taf_appMgmt_InitCommonData ( void  )

Init data that is common across all threads

◆ ifgen_taf_appMgmt_CleanupCommonData()

LE_SHARED void ifgen_taf_appMgmt_CleanupCommonData ( le_msg_SessionRef_t  _ifgen_sessionRef)

Cleanup the data of a session

◆ ifgen_taf_appMgmt_OpenSession()

LE_SHARED le_result_t ifgen_taf_appMgmt_OpenSession ( le_msg_SessionRef_t  _ifgen_sessionRef,
bool  isBlocking 
)

Perform common initialization and open a session

◆ ifgen_taf_appMgmt_GetState()

LE_SHARED taf_appMgmt_AppState_t ifgen_taf_appMgmt_GetState ( le_msg_SessionRef_t  _ifgen_sessionRef,
const char *LE_NONNULL  appName 
)

Gets the application's current state.

Returns
  • TAF_APPMGMT_STATE_STOPPED – App is not running.
  • TAF_APPMGMT_STATE_STARTED – App is running.
Parameters
[in]appNameApp name.

◆ ifgen_taf_appMgmt_GetVersion()

LE_SHARED le_result_t ifgen_taf_appMgmt_GetVersion ( le_msg_SessionRef_t  _ifgen_sessionRef,
const char *LE_NONNULL  appName,
char *  version,
size_t  versionSize 
)

Gets the application's version.

Returns
  • LE_BAD_PARAMETER – Bad parameter(s).
  • LE_NOT_FOUND – App not found.
  • LE_OK – Success.
Parameters
[in]appNameApp name.
[out]versionApp version.
[in]versionSize

◆ ifgen_taf_appMgmt_Start()

LE_SHARED le_result_t ifgen_taf_appMgmt_Start ( le_msg_SessionRef_t  _ifgen_sessionRef,
const char *LE_NONNULL  appName 
)

Starts an app.

Returns
  • LE_DUPLICATE – App is already running.
  • LE_BUSY – System is busy.
  • LE_FAULT – Failure.
  • LE_OK – Success.
Note
Installed apps are activated in a probation state when started for the first time.
Parameters
[in]appNameApp name.

◆ ifgen_taf_appMgmt_Stop()

LE_SHARED le_result_t ifgen_taf_appMgmt_Stop ( le_msg_SessionRef_t  _ifgen_sessionRef,
const char *LE_NONNULL  appName 
)

Stops an app.

Returns
  • LE_NOT_FOUND – App not found or not currently running; see note.
  • LE_OK – Success.
Note
Installed apps are not stopped if they are running in a Probation state.
Parameters
[in]appNameApp name.

◆ ifgen_taf_appMgmt_Uninstall()

LE_SHARED le_result_t ifgen_taf_appMgmt_Uninstall ( le_msg_SessionRef_t  _ifgen_sessionRef,
const char *LE_NONNULL  appName 
)

Uninstalls an app.

Returns
  • LE_NOT_FOUND – App not found.
  • LE_BUSY – System is busy.
  • LE_FAULT – Failure.
  • LE_OK – Success.
Note
Installed app is not allow to uninstall if in probation state.
Parameters
[in]appNameApp name.

◆ ifgen_taf_appMgmt_CreateAppList()

LE_SHARED taf_appMgmt_AppListRef_t ifgen_taf_appMgmt_CreateAppList ( le_msg_SessionRef_t  _ifgen_sessionRef)

Creates an app list.

Returns
  • Non-null pointer – The reference to the app list.
  • Null pointer – Internal error.

◆ ifgen_taf_appMgmt_DeleteAppList()

LE_SHARED le_result_t ifgen_taf_appMgmt_DeleteAppList ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_appMgmt_AppListRef_t  appListRef 
)

Deletes app list.

Returns
  • LE_BAD_PARAMETER – Bad parameters.
  • LE_NOT_FOUND – Reference not found.
  • LE_OK – Success.
Parameters
[in]appListRefThe reference to the app list.

◆ ifgen_taf_appMgmt_GetFirstApp()

LE_SHARED taf_appMgmt_AppRef_t ifgen_taf_appMgmt_GetFirstApp ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_appMgmt_AppListRef_t  appListRef 
)

Gets the first app.

Returns
  • Non-null pointer – The reference to the first app.
  • Null pointer – Internal error or empty list.
Parameters
[in]appListRefThe reference to the app list.

◆ ifgen_taf_appMgmt_GetNextApp()

LE_SHARED taf_appMgmt_AppRef_t ifgen_taf_appMgmt_GetNextApp ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_appMgmt_AppListRef_t  appListRef 
)

Gets the next app based on the current position in the list.

Returns
  • Non-null pointer – The reference to the next app.
  • Null pointer – Internal error or empty list.
Parameters
[in]appListRefThe reference to the app list.

◆ ifgen_taf_appMgmt_GetAppDetails()

LE_SHARED le_result_t ifgen_taf_appMgmt_GetAppDetails ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_appMgmt_AppRef_t  appRef,
taf_appMgmt_AppInfo_t *  appInfoPtr 
)

Gets app information.

Returns
  • LE_BAD_PARAMETER – Bad parameters.
  • LE_NOT_FOUND – Reference not found.
  • LE_OK – Success.
Note
Get static information when creating app list.
Parameters
[in]appRefThe reference to the app.
[out]appInfoPtrApp information.