Snapdragon® Telematics Application Framework (TelAF) Interface Specification
|
Go to the source code of this file.
Typedefs | |
typedef void(* | le_appInfo_DisconnectHandler_t) (void *) |
Functions | |
void | le_appInfo_ConnectService (void) |
le_result_t | le_appInfo_TryConnectService (void) |
LE_FULL_API void | le_appInfo_SetServerDisconnectHandler (le_appInfo_DisconnectHandler_t disconnectHandler, void *contextPtr) |
LE_FULL_API void | le_appInfo_SetNonExitServerDisconnectHandler (le_appInfo_DisconnectHandler_t disconnectHandler, void *contextPtr) |
void | le_appInfo_DisconnectService (void) |
le_appInfo_State_t | le_appInfo_GetState (const char *LE_NONNULL appName) |
le_appInfo_ProcState_t | le_appInfo_GetProcState (const char *LE_NONNULL appName, const char *LE_NONNULL procName) |
le_result_t | le_appInfo_GetName (int32_t pid, char *appName, size_t appNameSize) |
le_result_t | le_appInfo_GetHash (const char *LE_NONNULL appName, char *hashStr, size_t hashStrSize) |
Legato Application Information API include file.
Copyright (C) Sierra Wireless Inc.
typedef void(* le_appInfo_DisconnectHandler_t) (void *) |
Type for handler called when a server disconnects.
void le_appInfo_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.
le_result_t le_appInfo_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.
LE_FULL_API void le_appInfo_SetServerDisconnectHandler | ( | le_appInfo_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.
LE_FULL_API void le_appInfo_SetNonExitServerDisconnectHandler | ( | le_appInfo_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.
void le_appInfo_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.
le_appInfo_State_t le_appInfo_GetState | ( | const char *LE_NONNULL | appName | ) |
Gets the state of the specified application. The state of unknown applications is STOPPED.
[in] | appName | Application name. |
le_appInfo_ProcState_t le_appInfo_GetProcState | ( | const char *LE_NONNULL | appName, |
const char *LE_NONNULL | procName | ||
) |
Gets the state of the specified process in an application. This function only works for configured processes that the Supervisor starts directly.
[in] | appName | Application name. |
[in] | procName | Process name. |
le_result_t le_appInfo_GetName | ( | int32_t | pid, |
char * | appName, | ||
size_t | appNameSize | ||
) |
Gets the application name of the process with the specified PID.
[in] | pid | PID of the process. |
[out] | appName | Application name. |
[in] | appNameSize |
le_result_t le_appInfo_GetHash | ( | const char *LE_NONNULL | appName, |
char * | hashStr, | ||
size_t | hashStrSize | ||
) |
Gets the application hash as a hexidecimal string. The application hash is a unique hash of the current version of the application.
[in] | appName | Application name. |
[out] | hashStr | Hash string. |
[in] | hashStrSize |