le_instStat_common.h

Go to the documentation of this file.
    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_instStat_common.h
   12  *
   13  * Type definitions for le_instStat.
   14  *
   15  */
   16 #ifndef LE_INSTSTAT_COMMON_H_INCLUDE_GUARD
   17 #define LE_INSTSTAT_COMMON_H_INCLUDE_GUARD
   18 
   19 
   20 #include "legato.h"
   21 
   22 // Interface specific includes
   23 #include "le_limit_common.h"
   24 
   25 #define IFGEN_LE_INSTSTAT_PROTOCOL_ID "e160a983e92b4310ae8af3fbeff75a1b"
   26 #define IFGEN_LE_INSTSTAT_MSG_SIZE 59
   27 /** @addtogroup le_instStat
   28  *  @{ **/
   29 
   30 
   31 //--------------------------------------------------------------------------------------------------
   32 /**
   33  * Reference type used by Add/Remove functions for EVENT 'le_instStat_AppInstallEvent'
   34  */
   35 //--------------------------------------------------------------------------------------------------
   36 typedef struct le_instStat_AppInstallEventHandler* le_instStat_AppInstallEventHandlerRef_t;
   37 
   38 
   39 //--------------------------------------------------------------------------------------------------
   40 /**
   41  * Reference type used by Add/Remove functions for EVENT 'le_instStat_AppUninstallEvent'
   42  */
   43 //--------------------------------------------------------------------------------------------------
   44 typedef struct le_instStat_AppUninstallEventHandler* le_instStat_AppUninstallEventHandlerRef_t;
   45 
   46 
   47 //--------------------------------------------------------------------------------------------------
   48 /**
   49  * Handler for application install.  Called when an application is installed.
   50  */
   51 //--------------------------------------------------------------------------------------------------
   52 typedef void (*le_instStat_AppInstallHandlerFunc_t)
   53 (
   54         const char* LE_NONNULL appName,
   55         ///< Name of the application installed.
   56         void* contextPtr
   57         ///<
   58 );
   59 
   60 //--------------------------------------------------------------------------------------------------
   61 /**
   62  * Handler for application uninstall.  Called when an application is uninstalled.
   63  */
   64 //--------------------------------------------------------------------------------------------------
   65 typedef void (*le_instStat_AppUninstallHandlerFunc_t)
   66 (
   67         const char* LE_NONNULL appName,
   68         ///< Name of the application uninstalled.
   69         void* contextPtr
   70         ///<
   71 );
   72 
   73 
   74 //--------------------------------------------------------------------------------------------------
   75 /**
   76  * Get if this client bound locally.
   77  */
   78 //--------------------------------------------------------------------------------------------------
   79 LE_SHARED bool ifgen_le_instStat_HasLocalBinding
   80 (
   81     void
   82 );
   83 
   84 
   85 //--------------------------------------------------------------------------------------------------
   86 /**
   87  * Init data that is common across all threads
   88  */
   89 //--------------------------------------------------------------------------------------------------
   90 LE_SHARED void ifgen_le_instStat_InitCommonData
   91 (
   92     void
   93 );
   94 
   95 
   96 //--------------------------------------------------------------------------------------------------
   97 /**
   98  * Perform common initialization and open a session
   99  */
  100 //--------------------------------------------------------------------------------------------------
  101 LE_SHARED le_result_t ifgen_le_instStat_OpenSession
  102 (
  103     le_msg_SessionRef_t _ifgen_sessionRef,
  104     bool isBlocking
  105 );
  106 
  107 //--------------------------------------------------------------------------------------------------
  108 /**
  109  * Add handler function for EVENT 'le_instStat_AppInstallEvent'
  110  *
  111  * This event provides a notification of when an application is installed.
  112  */
  113 //--------------------------------------------------------------------------------------------------
  114 LE_SHARED le_instStat_AppInstallEventHandlerRef_t ifgen_le_instStat_AddAppInstallEventHandler
  115 (
  116     le_msg_SessionRef_t _ifgen_sessionRef,
  117         le_instStat_AppInstallHandlerFunc_t handlerPtr,
  118         ///< [IN]
  119         void* contextPtr
  120         ///< [IN]
  121 );
  122 
  123 //--------------------------------------------------------------------------------------------------
  124 /**
  125  * Remove handler function for EVENT 'le_instStat_AppInstallEvent'
  126  */
  127 //--------------------------------------------------------------------------------------------------
  128 LE_SHARED void ifgen_le_instStat_RemoveAppInstallEventHandler
  129 (
  130     le_msg_SessionRef_t _ifgen_sessionRef,
  131         le_instStat_AppInstallEventHandlerRef_t handlerRef
  132         ///< [IN]
  133 );
  134 
  135 //--------------------------------------------------------------------------------------------------
  136 /**
  137  * Add handler function for EVENT 'le_instStat_AppUninstallEvent'
  138  *
  139  * This event provides a notification of when an application is uninstalled.
  140  */
  141 //--------------------------------------------------------------------------------------------------
  142 LE_SHARED le_instStat_AppUninstallEventHandlerRef_t ifgen_le_instStat_AddAppUninstallEventHandler
  143 (
  144     le_msg_SessionRef_t _ifgen_sessionRef,
  145         le_instStat_AppUninstallHandlerFunc_t handlerPtr,
  146         ///< [IN]
  147         void* contextPtr
  148         ///< [IN]
  149 );
  150 
  151 //--------------------------------------------------------------------------------------------------
  152 /**
  153  * Remove handler function for EVENT 'le_instStat_AppUninstallEvent'
  154  */
  155 //--------------------------------------------------------------------------------------------------
  156 LE_SHARED void ifgen_le_instStat_RemoveAppUninstallEventHandler
  157 (
  158     le_msg_SessionRef_t _ifgen_sessionRef,
  159         le_instStat_AppUninstallEventHandlerRef_t handlerRef
  160         ///< [IN]
  161 );
  162 /** @} **/
  163 #endif // LE_INSTSTAT_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_instStat_AppInstallEventHandlerRef_t
struct le_instStat_AppInstallEventHandler * le_instStat_AppInstallEventHandlerRef_t
Definition: le_instStat_common.h:36


le_limit_common.h


le_instStat_AppUninstallHandlerFunc_t
void(* le_instStat_AppUninstallHandlerFunc_t)(const char *LE_NONNULL appName, void *contextPtr)
Definition: le_instStat_common.h:66


le_msg_SessionRef_t
struct le_msg_Session * le_msg_SessionRef_t
Definition: le_messaging.h:860



le_instStat_AppUninstallEventHandlerRef_t
struct le_instStat_AppUninstallEventHandler * le_instStat_AppUninstallEventHandlerRef_t
Definition: le_instStat_common.h:44


le_instStat_AppInstallHandlerFunc_t
void(* le_instStat_AppInstallHandlerFunc_t)(const char *LE_NONNULL appName, void *contextPtr)
Definition: le_instStat_common.h:53