le_framework_interface.h

    1 /*
    2  * ====================== WARNING ======================
    3  *
    4  * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
    5  * DO NOT MODIFY IN ANY WAY.
    6  *
    7  * ====================== WARNING ======================
    8  */
    9 
   10 /**
   11  * @page c_framework Framework Control API
   12  *
   13  * @ref le_framework_interface.h "API Reference"
   14  *
   15  * API for controlling the framework. This API should only be made available to privileged users.
   16  *
   17  * @section legatoServicesSupervisor_binding Binding
   18  *
   19  * You can use a definition @c .adef file to bind your client-side app and component to the
   20  * server-side Framework Control service.
   21  *
   22  * This code sample shows how to bind an app to this service:
   23  * @code
   24  * bindings
   25  * {
   26  *     myExe.myComp.le_framework -> <root>.le_framework
   27  * }
   28  * @endcode
   29  *
   30  * See @ref defFilesAdef for details.
   31  *
   32  * <HR>
   33  *
   34  * Copyright (C) Sierra Wireless Inc. Use of this work is subject to license.
   35  */
   36 /**
   37  * @file le_framework_interface.h
   38  *
   39  * Legato @ref c_framework include file.
   40  *
   41  * Copyright (C) Sierra Wireless Inc. Use of this work is subject to license.
   42  */
   43 
   44 #ifndef LE_FRAMEWORK_INTERFACE_H_INCLUDE_GUARD
   45 #define LE_FRAMEWORK_INTERFACE_H_INCLUDE_GUARD
   46 
   47 
   48 #include "legato.h"
   49 
   50 //--------------------------------------------------------------------------------------------------
   51 /**
   52  *
   53  * Connect the current client thread to the service providing this API. Block until the service is
   54  * available.
   55  *
   56  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
   57  * called before any other functions in this API.  Normally, ConnectService is automatically called
   58  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
   59  *
   60  * This function is created automatically.
   61  */
   62 //--------------------------------------------------------------------------------------------------
   63 void le_framework_ConnectService
   64 (
   65     void
   66 );
   67 
   68 //--------------------------------------------------------------------------------------------------
   69 /**
   70  *
   71  * Try to connect the current client thread to the service providing this API. Return with an error
   72  * if the service is not available.
   73  *
   74  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
   75  * called before any other functions in this API.  Normally, ConnectService is automatically called
   76  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
   77  *
   78  * This function is created automatically.
   79  *
   80  * @return
   81  *  - LE_OK if the client connected successfully to the service.
   82  *  - LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
   83  *  - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
   84  *  - LE_COMM_ERROR if the Service Directory cannot be reached.
   85  */
   86 //--------------------------------------------------------------------------------------------------
   87 le_result_t le_framework_TryConnectService
   88 (
   89     void
   90 );
   91 
   92 //--------------------------------------------------------------------------------------------------
   93 /**
   94  *
   95  * Disconnect the current client thread from the service providing this API.
   96  *
   97  * Normally, this function doesn't need to be called. After this function is called, there's no
   98  * longer a connection to the service, and the functions in this API can't be used. For details, see
   99  * @ref apiFilesC_client.
  100  *
  101  * This function is created automatically.
  102  */
  103 //--------------------------------------------------------------------------------------------------
  104 void le_framework_DisconnectService
  105 (
  106     void
  107 );
  108 
  109 //--------------------------------------------------------------------------------------------------
  110 /**
  111  * Stops the Legato framework.
  112  *
  113  * @return
  114  *      LE_OK if successful.
  115  *      LE_DUPLICATE if the framework is in the process of shutting down (perhaps someone else has
  116  *                   already requested the framework be stopped or restarted).
  117  */
  118 //--------------------------------------------------------------------------------------------------
  119 le_result_t le_framework_Stop
  120 (
  121     void
  122 );
  123 
  124 //--------------------------------------------------------------------------------------------------
  125 /**
  126  * Restarts the Legato framework.
  127  *
  128  * @return
  129  *      LE_OK if the request was accepted and the restart procedure has begun.
  130  *      LE_DUPLICATE if the framework is already in the process of shutting down (perhaps someone
  131  *                   else has already requested the framework be stopped or restarted).
  132  */
  133 //--------------------------------------------------------------------------------------------------
  134 le_result_t le_framework_Restart
  135 (
  136     bool manualRestart
  137         ///< [IN] Was the restart manually triggered e.g. "legato restart"
  138 );
  139 
  140 
  141 #endif // LE_FRAMEWORK_INTERFACE_H_INCLUDE_GUARD
  142 
le_result_t
le_result_t
Definition: le_basics.h:35
le_framework_DisconnectService
void le_framework_DisconnectService(void)
le_framework_Restart
le_result_t le_framework_Restart(bool manualRestart)
le_framework_TryConnectService
le_result_t le_framework_TryConnectService(void)
le_framework_Stop
le_result_t le_framework_Stop(void)
legato.h
le_framework_ConnectService
void le_framework_ConnectService(void)