le_sup_ctrl_interface.h File Reference
#include "legato.h"
#include "le_limit_interface.h"

Go to the source code of this file.

Functions

void le_sup_ctrl_ConnectService (void)
 
void le_sup_ctrl_DisconnectService (void)
 
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.

This function must be called before any other functions in this API. Normally, it's automatically called for the main thread, but must be explicitly called for other threads. 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_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]manualRestartWas the restart manually triggered e.g. "legato restart"
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]appNameName 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]appNameName 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).