Snapdragon® Telematics Application Framework (TelAF) Interface Specification
|
Go to the source code of this file.
Typedefs | |
typedef void(* | le_appCtrl_DisconnectHandler_t) (void *) |
Legato App Control API include file.
Copyright (C) Sierra Wireless Inc.
typedef void(* le_appCtrl_DisconnectHandler_t) (void *) |
Type for handler called when a server disconnects.
void le_appCtrl_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_appCtrl_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_appCtrl_SetServerDisconnectHandler | ( | le_appCtrl_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_appCtrl_SetNonExitServerDisconnectHandler | ( | le_appCtrl_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_appCtrl_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_appCtrl_AppRef_t le_appCtrl_GetRef | ( | const char *LE_NONNULL | appName | ) |
Gets a reference to an app.
[in] | appName | Name of the app to get the ref for. |
void le_appCtrl_ReleaseRef | ( | le_appCtrl_AppRef_t | appRef | ) |
Release the reference to an app, resetting all overrides set for this app using other functions, like SetRun(), SetDevicePerm(), etc.
[in] | appRef | Ref to the app. |
void le_appCtrl_SetRun | ( | le_appCtrl_AppRef_t | appRef, |
const char *LE_NONNULL | procName, | ||
bool | run | ||
) |
Sets the run flag for a process in an app.
If there is an error this function will kill the calling client.
[in] | appRef | Ref to the app. |
[in] | procName | Process name to set the run flag for. |
[in] | run | Flag to run the process or not. |
void le_appCtrl_SetDebug | ( | le_appCtrl_AppRef_t | appRef, |
const char *LE_NONNULL | procName, | ||
bool | debug | ||
) |
Sets the debug flag for a process in an app.
If there is an error this function will kill the calling client.
[in] | appRef | Ref to the app. |
[in] | procName | Process name to set the run flag for. |
[in] | debug | Flag to debug the process or not. |
le_result_t le_appCtrl_Import | ( | le_appCtrl_AppRef_t | appRef, |
const char *LE_NONNULL | path | ||
) |
Imports a file into the app's working directory.
[in] | appRef | Ref to the app. |
[in] | path | Absolute path to the file to import. |
le_result_t le_appCtrl_SetDevicePerm | ( | le_appCtrl_AppRef_t | appRef, |
const char *LE_NONNULL | path, | ||
const char *LE_NONNULL | permissions | ||
) |
Sets a device file's permissions.
[in] | appRef | Ref to the app. |
[in] | path | Absolute path to the device. |
[in] | permissions | Permission string, "r", "w", "rw". |
le_appCtrl_TraceAttachHandlerRef_t le_appCtrl_AddTraceAttachHandler | ( | le_appCtrl_AppRef_t | appRef, |
le_appCtrl_TraceAttachHandlerFunc_t | attachToPidPtr, | ||
void * | contextPtr | ||
) |
Add handler function for EVENT 'le_appCtrl_TraceAttach'
Event that indicates the process is blocked and can be attached to.
[in] | appRef | Ref to the app. |
[in] | attachToPidPtr | Attach handler to register. |
[in] | contextPtr |
void le_appCtrl_RemoveTraceAttachHandler | ( | le_appCtrl_TraceAttachHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'le_appCtrl_TraceAttach'
[in] | handlerRef |
void le_appCtrl_TraceUnblock | ( | le_appCtrl_AppRef_t | appRef, |
int32_t | pid | ||
) |
Unblocks the traced process. This should normally be done once the tracer has successfully attached to the process.
[in] | appRef | Ref to the app. |
[in] | pid | PID of the process to unblock. |
le_result_t le_appCtrl_Start | ( | const char *LE_NONNULL | appName | ) |
Starts an app.
[in] | appName | Name of the app to start. |
le_result_t le_appCtrl_Stop | ( | const char *LE_NONNULL | appName | ) |
Stops an app.
[in] | appName | Name of the app to stop. |