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

Go to the source code of this file.

Typedefs

typedef void(* taf_appMgmt_DisconnectHandler_t) (void *)
 

Functions

void taf_appMgmt_ConnectService (void)
 
le_result_t taf_appMgmt_TryConnectService (void)
 
LE_FULL_API void taf_appMgmt_SetServerDisconnectHandler (taf_appMgmt_DisconnectHandler_t disconnectHandler, void *contextPtr)
 
LE_FULL_API void taf_appMgmt_SetNonExitServerDisconnectHandler (taf_appMgmt_DisconnectHandler_t disconnectHandler, void *contextPtr)
 
void taf_appMgmt_DisconnectService (void)
 
taf_appMgmt_AppState_t taf_appMgmt_GetState (const char *LE_NONNULL appName)
 
le_result_t taf_appMgmt_GetVersion (const char *LE_NONNULL appName, char *version, size_t versionSize)
 
le_result_t taf_appMgmt_Start (const char *LE_NONNULL appName)
 
le_result_t taf_appMgmt_Stop (const char *LE_NONNULL appName)
 
le_result_t taf_appMgmt_Uninstall (const char *LE_NONNULL appName)
 
taf_appMgmt_AppListRef_t taf_appMgmt_CreateAppList (void)
 
le_result_t taf_appMgmt_DeleteAppList (taf_appMgmt_AppListRef_t appListRef)
 
taf_appMgmt_AppRef_t taf_appMgmt_GetFirstApp (taf_appMgmt_AppListRef_t appListRef)
 
taf_appMgmt_AppRef_t taf_appMgmt_GetNextApp (taf_appMgmt_AppListRef_t appListRef)
 
le_result_t taf_appMgmt_GetAppDetails (taf_appMgmt_AppRef_t appRef, taf_appMgmt_AppInfo_t *appInfoPtr)
 

Typedef Documentation

◆ taf_appMgmt_DisconnectHandler_t

typedef void(* taf_appMgmt_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

Function Documentation

◆ taf_appMgmt_ConnectService()

void taf_appMgmt_ConnectService ( void  )

Connect the current client thread to the service providing this API. Block until the service is available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see apiFilesC_client.

This function is created automatically.

◆ taf_appMgmt_TryConnectService()

le_result_t taf_appMgmt_TryConnectService ( void  )

Try to connect the current client thread to the service providing this API. Return with an error if the service is not available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see apiFilesC_client.

This function is created automatically.

Returns
  • LE_OK if the client connected successfully to the service.
  • LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
  • LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
  • LE_COMM_ERROR if the Service Directory cannot be reached.

◆ taf_appMgmt_SetServerDisconnectHandler()

LE_FULL_API void taf_appMgmt_SetServerDisconnectHandler ( taf_appMgmt_DisconnectHandler_t  disconnectHandler,
void *  contextPtr 
)

Set handler called when server disconnection is detected.

When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants to continue without exiting, it should call longjmp() from inside the handler.

◆ taf_appMgmt_SetNonExitServerDisconnectHandler()

LE_FULL_API void taf_appMgmt_SetNonExitServerDisconnectHandler ( taf_appMgmt_DisconnectHandler_t  disconnectHandler,
void *  contextPtr 
)

Set handler called when server disconnection is detected without exiting.

When a server connection is lost, call this handler without exit.

Warning
When using the API, it needs the application developer to handle some cases like re-connecting and recycling the resources. For most of cases, it is safe to use SetServerDisconnectHandler.

◆ taf_appMgmt_DisconnectService()

void taf_appMgmt_DisconnectService ( void  )

Disconnect the current client thread from the service providing this API.

Normally, this function doesn't need to be called. After this function is called, there's no longer a connection to the service, and the functions in this API can't be used. For details, see apiFilesC_client.

This function is created automatically.

◆ taf_appMgmt_GetState()

taf_appMgmt_AppState_t taf_appMgmt_GetState ( 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.

◆ taf_appMgmt_GetVersion()

le_result_t taf_appMgmt_GetVersion ( 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

◆ taf_appMgmt_Start()

le_result_t taf_appMgmt_Start ( 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.

◆ taf_appMgmt_Stop()

le_result_t taf_appMgmt_Stop ( 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.

◆ taf_appMgmt_Uninstall()

le_result_t taf_appMgmt_Uninstall ( 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.

◆ taf_appMgmt_CreateAppList()

taf_appMgmt_AppListRef_t taf_appMgmt_CreateAppList ( void  )

Creates an app list.

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

◆ taf_appMgmt_DeleteAppList()

le_result_t taf_appMgmt_DeleteAppList ( 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.

◆ taf_appMgmt_GetFirstApp()

taf_appMgmt_AppRef_t taf_appMgmt_GetFirstApp ( 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.

◆ taf_appMgmt_GetNextApp()

taf_appMgmt_AppRef_t taf_appMgmt_GetNextApp ( 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.

◆ taf_appMgmt_GetAppDetails()

le_result_t taf_appMgmt_GetAppDetails ( 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.