Go to the source code of this file.
Typedefs | |
| typedef struct le_sup_ctrl_App * | le_sup_ctrl_AppRef_t |
Functions | |
| void | le_sup_ctrl_ConnectService (void) |
| le_result_t | le_sup_ctrl_TryConnectService (void) |
| void | le_sup_ctrl_DisconnectService (void) |
| le_sup_ctrl_AppRef_t | le_sup_ctrl_GetAppRef (const char *appName) |
| void | le_sup_ctrl_ReleaseAppRef (le_sup_ctrl_AppRef_t appRef) |
| void | le_sup_ctrl_SetRun (le_sup_ctrl_AppRef_t appRef, const char *procName, bool run) |
| le_result_t | le_sup_ctrl_StartApp (const char *appName) |
| le_result_t | le_sup_ctrl_StopApp (const char *appName) |
| le_result_t | le_sup_ctrl_StopLegato (void) |
| le_result_t | le_sup_ctrl_RestartLegato (bool manualRestart) |
Detailed Description
Legato Supervisor Control API include file.
Copyright (C) Sierra Wireless Inc. Use of this work is subject to license.
Function Documentation
| void le_sup_ctrl_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_sup_ctrl_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_sup_ctrl_AppRef_t le_sup_ctrl_GetAppRef | ( | 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.
| void le_sup_ctrl_ReleaseAppRef | ( | le_sup_ctrl_AppRef_t | appRef | ) |
Release the reference to an application.
- Parameters
-
[in] appRef Ref to the app.
| le_result_t le_sup_ctrl_RestartLegato | ( | bool | manualRestart | ) |
Restarts the Legato framework.
- Returns
- LE_OK if the request was accepted and the restart procedure has begun. LE_DUPLICATE if the framework is already in the process of shutting down (perhaps someone else has already requested the framework be stopped or restarted).
- Parameters
-
[in] manualRestart Was the restart manually triggered e.g. "legato restart"
| void le_sup_ctrl_SetRun | ( | le_sup_ctrl_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_sup_ctrl_StartApp | ( | 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_sup_ctrl_StopApp | ( | 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.
| le_result_t le_sup_ctrl_StopLegato | ( | void | ) |
Stops the Legato framework.
- Returns
- LE_OK if successful. LE_DUPLICATE if the framework is in the process of shutting down (perhaps someone else has already requested the framework be stopped or restarted).
| le_result_t le_sup_ctrl_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.