Go to the source code of this file.
Typedefs | |
typedef struct le_appCtrl_App * | le_appCtrl_AppRef_t |
typedef struct le_appCtrl_TraceAttachHandler * | le_appCtrl_TraceAttachHandlerRef_t |
typedef void(* | le_appCtrl_TraceAttachHandlerFunc_t) (le_appCtrl_AppRef_t appRef, int32_t pid, const char *procName, void *contextPtr) |
Functions | |
void | le_appCtrl_ConnectService (void) |
le_result_t | le_appCtrl_TryConnectService (void) |
void | le_appCtrl_DisconnectService (void) |
le_appCtrl_AppRef_t | le_appCtrl_GetRef (const char *appName) |
void | le_appCtrl_ReleaseRef (le_appCtrl_AppRef_t appRef) |
void | le_appCtrl_SetRun (le_appCtrl_AppRef_t appRef, const char *procName, bool run) |
le_result_t | le_appCtrl_Import (le_appCtrl_AppRef_t appRef, const char *path) |
le_result_t | le_appCtrl_SetDevicePerm (le_appCtrl_AppRef_t appRef, const char *path, const char *permissions) |
le_appCtrl_TraceAttachHandlerRef_t | le_appCtrl_AddTraceAttachHandler (le_appCtrl_AppRef_t appRef, le_appCtrl_TraceAttachHandlerFunc_t attachToPidPtr, void *contextPtr) |
void | le_appCtrl_RemoveTraceAttachHandler (le_appCtrl_TraceAttachHandlerRef_t addHandlerRef) |
void | le_appCtrl_TraceUnblock (le_appCtrl_AppRef_t appRef, int32_t pid) |
le_result_t | le_appCtrl_Start (const char *appName) |
le_result_t | le_appCtrl_Stop (const char *appName) |
Detailed Description
Legato App Control API include file.
Copyright (C) Sierra Wireless Inc. Use of this work is subject to license.
Typedef Documentation
typedef void(* le_appCtrl_TraceAttachHandlerFunc_t) (le_appCtrl_AppRef_t appRef, int32_t pid, const char *procName, void *contextPtr) |
Handler for attaching to a process that is to be traced. The process is blocked allowing the tracer to attach to it. The tracer must call TraceUnblock() to unblock the traced process.
- Parameters
-
appRef Ref to the app. pid PID of a process that can be attached to. procName Name of the process name. contextPtr
typedef struct le_appCtrl_TraceAttachHandler* le_appCtrl_TraceAttachHandlerRef_t |
Reference type used by Add/Remove functions for EVENT 'le_appCtrl_TraceAttach'
Function Documentation
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.
- Parameters
-
[in] appRef Ref to the app. [in] attachToPidPtr [in] contextPtr
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 Client-specific Functions.
This function is created automatically.
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 Client-specific Functions.
This function is created automatically.
le_appCtrl_AppRef_t le_appCtrl_GetRef | ( | const char * | appName | ) |
Gets a reference to an application.
- Returns
- Reference to the named app. NULL if the app is not installed.
- Parameters
-
[in] appName Name of the app to get the ref for.
le_result_t le_appCtrl_Import | ( | le_appCtrl_AppRef_t | appRef, |
const char * | path | ||
) |
Imports a file into the app's working directory.
- Returns
- LE_OK if successfully imported the file. LE_DUPLICATE if the path conflicts with items already in the app's working directory. LE_NOT_FOUND if the path does not point to a valid file. LE_BAD_PARAMETER if the path is formatted incorrectly. LE_FAULT if there was some other error.
- Parameters
-
[in] appRef Ref to the app. [in] path Absolute path to the file to import.
void le_appCtrl_ReleaseRef | ( | le_appCtrl_AppRef_t | appRef | ) |
Release the reference to an application.
- Parameters
-
[in] appRef Ref to the app.
void le_appCtrl_RemoveTraceAttachHandler | ( | le_appCtrl_TraceAttachHandlerRef_t | addHandlerRef | ) |
Remove handler function for EVENT 'le_appCtrl_TraceAttach'
- Parameters
-
[in] addHandlerRef
le_result_t le_appCtrl_SetDevicePerm | ( | le_appCtrl_AppRef_t | appRef, |
const char * | path, | ||
const char * | permissions | ||
) |
Sets a device file's permissions.
- Returns
- LE_OK if successfully set the device's permissions. LE_NOT_FOUND if the path does not point to a valid device. LE_BAD_PARAMETER if the path is formatted incorrectly. LE_FAULT if there was some other error.
- Parameters
-
[in] appRef Ref to the app. [in] path Absolute path to the device. [in] permissions Permission string, "r", "w", "rw".
void le_appCtrl_SetRun | ( | le_appCtrl_AppRef_t | appRef, |
const char * | procName, | ||
bool | run | ||
) |
Sets the run flag for a process in an application.
If there is an error this function will kill the calling client.
- Parameters
-
[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.
le_result_t le_appCtrl_Start | ( | const char * | appName | ) |
Starts an app.
- Returns
- LE_OK if the app is successfully started. LE_DUPLICATE if the app is already running. LE_NOT_FOUND if the app isn't installed. LE_FAULT if there was an error and the app could not be launched.
- Parameters
-
[in] appName Name of the app to start.
le_result_t le_appCtrl_Stop | ( | const char * | appName | ) |
Stops an app.
- Returns
- LE_OK if successful. LE_NOT_FOUND if the app could not be found.
- Parameters
-
[in] appName Name of the app to stop.
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.
- Parameters
-
[in] appRef Ref to the app. [in] pid PID of the process to unblock.
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 Client-specific Functions.
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.