le_framework_common.h

    1 
    2 /*
    3  * ====================== WARNING ======================
    4  *
    5  * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
    6  * DO NOT MODIFY IN ANY WAY.
    7  *
    8  * ====================== WARNING ======================
    9  */
   10 /**
   11  * @file le_framework_common.h
   12  *
   13  * Type definitions for le_framework.
   14  *
   15  */
   16 #ifndef LE_FRAMEWORK_COMMON_H_INCLUDE_GUARD
   17 #define LE_FRAMEWORK_COMMON_H_INCLUDE_GUARD
   18 
   19 
   20 #include "legato.h"
   21 
   22 #define IFGEN_LE_FRAMEWORK_PROTOCOL_ID "28525bdc36d66247ae720424d0b28b51"
   23 #define IFGEN_LE_FRAMEWORK_MSG_SIZE 12
   24 /** @addtogroup le_framework
   25  *  @{ **/
   26 
   27 
   28 
   29 //--------------------------------------------------------------------------------------------------
   30 /**
   31  * Get if this client bound locally.
   32  */
   33 //--------------------------------------------------------------------------------------------------
   34 LE_SHARED bool ifgen_le_framework_HasLocalBinding
   35 (
   36     void
   37 );
   38 
   39 
   40 //--------------------------------------------------------------------------------------------------
   41 /**
   42  * Init data that is common across all threads
   43  */
   44 //--------------------------------------------------------------------------------------------------
   45 LE_SHARED void ifgen_le_framework_InitCommonData
   46 (
   47     void
   48 );
   49 
   50 
   51 //--------------------------------------------------------------------------------------------------
   52 /**
   53  * Perform common initialization and open a session
   54  */
   55 //--------------------------------------------------------------------------------------------------
   56 LE_SHARED le_result_t ifgen_le_framework_OpenSession
   57 (
   58     le_msg_SessionRef_t _ifgen_sessionRef,
   59     bool isBlocking
   60 );
   61 
   62 //--------------------------------------------------------------------------------------------------
   63 /**
   64  * Stops the Legato framework.
   65  *
   66  * @return
   67  *      LE_OK if successful.
   68  *      LE_DUPLICATE if the framework is in the process of shutting down (perhaps someone else has
   69  *                   already requested the framework be stopped or restarted).
   70  */
   71 //--------------------------------------------------------------------------------------------------
   72 LE_SHARED le_result_t ifgen_le_framework_Stop
   73 (
   74     le_msg_SessionRef_t _ifgen_sessionRef
   75 );
   76 
   77 //--------------------------------------------------------------------------------------------------
   78 /**
   79  * Restarts the Legato framework.
   80  *
   81  * @return
   82  *      LE_OK if the request was accepted and the restart procedure has begun.
   83  *      LE_DUPLICATE if the framework is already in the process of shutting down (perhaps someone
   84  *                   else has already requested the framework be stopped or restarted).
   85  */
   86 //--------------------------------------------------------------------------------------------------
   87 LE_SHARED le_result_t ifgen_le_framework_Restart
   88 (
   89     le_msg_SessionRef_t _ifgen_sessionRef,
   90         bool manualRestart
   91         ///< [IN] Was the restart manually triggered e.g. "legato restart"
   92 );
   93 
   94 //--------------------------------------------------------------------------------------------------
   95 /**
   96  * Reports if the Legato framework is stopping.
   97  *
   98  * @return
   99  *     true if the framework is stopping or rebooting
  100  *     false otherwise
  101  */
  102 //--------------------------------------------------------------------------------------------------
  103 LE_SHARED bool ifgen_le_framework_IsStopping
  104 (
  105     le_msg_SessionRef_t _ifgen_sessionRef
  106 );
  107 
  108 //--------------------------------------------------------------------------------------------------
  109 /**
  110  * Checks whether legato framework is Read-Only or not.
  111  *
  112  * @return
  113  *     true if the framework is Read-Only
  114  *     false otherwise
  115  */
  116 //--------------------------------------------------------------------------------------------------
  117 LE_SHARED bool ifgen_le_framework_IsReadOnly
  118 (
  119     le_msg_SessionRef_t _ifgen_sessionRef
  120 );
  121 
  122 //--------------------------------------------------------------------------------------------------
  123 /**
  124  * Mark the next reboot as expected. Should be called by short lived app that shutdown platform
  125  * after a small wakeup. This prevents system not to rollback on expected reboot.
  126  */
  127 //--------------------------------------------------------------------------------------------------
  128 LE_SHARED void ifgen_le_framework_NotifyExpectedReboot
  129 (
  130     le_msg_SessionRef_t _ifgen_sessionRef
  131 );
  132 /** @} **/
  133 #endif // LE_FRAMEWORK_COMMON_H_INCLUDE_GUARD
LE_SHARED
#define LE_SHARED
Definition: le_basics.h:300
le_result_t
le_result_t
Definition: le_basics.h:46
le_msg_SessionRef_t
struct le_msg_Session * le_msg_SessionRef_t
Definition: le_messaging.h:860
legato.h