le_instStat_interface.h

Go to the documentation of this file.
    1 
    2 
    3 /*
    4  * ====================== WARNING ======================
    5  *
    6  * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
    7  * DO NOT MODIFY IN ANY WAY.
    8  *
    9  * ====================== WARNING ======================
   10  */
   11 
   12 /**
   13  * @page c_le_instStat Install Status API
   14  *
   15  * @ref le_instStat_interface.h "API Reference"
   16  *
   17  * This API provides notifications when apps are installed and uninstalled.
   18  *
   19  * <HR>
   20  *
   21  * Copyright (C) Sierra Wireless Inc.
   22  */
   23 /**
   24  * @file le_instStat_interface.h
   25  *
   26  * Legato @ref c_le_instStat include file.
   27  *
   28  * Copyright (C) Sierra Wireless Inc.
   29  */
   30 
   31 #ifndef LE_INSTSTAT_INTERFACE_H_INCLUDE_GUARD
   32 #define LE_INSTSTAT_INTERFACE_H_INCLUDE_GUARD
   33 
   34 
   35 #include "legato.h"
   36 
   37 // Interface specific includes
   38 #include "le_limit_interface.h"
   39 
   40 // Internal includes for this interface
   41 #include "le_instStat_common.h"
   42 /** @addtogroup le_instStat le_instStat API Reference
   43  * @{
   44  * @file le_instStat_common.h
   45  * @file le_instStat_interface.h **/
   46 //--------------------------------------------------------------------------------------------------
   47 /**
   48  * Type for handler called when a server disconnects.
   49  */
   50 //--------------------------------------------------------------------------------------------------
   51 typedef void (*le_instStat_DisconnectHandler_t)(void *);
   52 
   53 //--------------------------------------------------------------------------------------------------
   54 /**
   55  *
   56  * Connect the current client thread to the service providing this API. Block until the service is
   57  * available.
   58  *
   59  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
   60  * called before any other functions in this API.  Normally, ConnectService is automatically called
   61  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
   62  *
   63  * This function is created automatically.
   64  */
   65 //--------------------------------------------------------------------------------------------------
   66 void le_instStat_ConnectService
   67 (
   68     void
   69 );
   70 
   71 //--------------------------------------------------------------------------------------------------
   72 /**
   73  *
   74  * Try to connect the current client thread to the service providing this API. Return with an error
   75  * if the service is not available.
   76  *
   77  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
   78  * called before any other functions in this API.  Normally, ConnectService is automatically called
   79  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
   80  *
   81  * This function is created automatically.
   82  *
   83  * @return
   84  *  - LE_OK if the client connected successfully to the service.
   85  *  - LE_UNAVAILABLE if the server is not currently offering the service to which the client is
   86  *    bound.
   87  *  - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
   88  *  - LE_COMM_ERROR if the Service Directory cannot be reached.
   89  */
   90 //--------------------------------------------------------------------------------------------------
   91 le_result_t le_instStat_TryConnectService
   92 (
   93     void
   94 );
   95 
   96 //--------------------------------------------------------------------------------------------------
   97 /**
   98  * Set handler called when server disconnection is detected.
   99  *
  100  * When a server connection is lost, call this handler then exit with LE_FATAL.  If a program wants
  101  * to continue without exiting, it should call longjmp() from inside the handler.
  102  */
  103 //--------------------------------------------------------------------------------------------------
  104 LE_FULL_API void le_instStat_SetServerDisconnectHandler
  105 (
  106     le_instStat_DisconnectHandler_t disconnectHandler,
  107     void *contextPtr
  108 );
  109 
  110 //--------------------------------------------------------------------------------------------------
  111 /**
  112  *
  113  * Disconnect the current client thread from the service providing this API.
  114  *
  115  * Normally, this function doesn't need to be called. After this function is called, there's no
  116  * longer a connection to the service, and the functions in this API can't be used. For details, see
  117  * @ref apiFilesC_client.
  118  *
  119  * This function is created automatically.
  120  */
  121 //--------------------------------------------------------------------------------------------------
  122 void le_instStat_DisconnectService
  123 (
  124     void
  125 );
  126 
  127 
  128 //--------------------------------------------------------------------------------------------------
  129 /**
  130  * Handler for application install.  Called when an application is installed.
  131  */
  132 //--------------------------------------------------------------------------------------------------
  133 
  134 
  135 //--------------------------------------------------------------------------------------------------
  136 /**
  137  * Reference type used by Add/Remove functions for EVENT 'le_instStat_AppInstallEvent'
  138  */
  139 //--------------------------------------------------------------------------------------------------
  140 
  141 
  142 //--------------------------------------------------------------------------------------------------
  143 /**
  144  * Handler for application uninstall.  Called when an application is uninstalled.
  145  */
  146 //--------------------------------------------------------------------------------------------------
  147 
  148 
  149 //--------------------------------------------------------------------------------------------------
  150 /**
  151  * Reference type used by Add/Remove functions for EVENT 'le_instStat_AppUninstallEvent'
  152  */
  153 //--------------------------------------------------------------------------------------------------
  154 
  155 
  156 //--------------------------------------------------------------------------------------------------
  157 /**
  158  * Add handler function for EVENT 'le_instStat_AppInstallEvent'
  159  *
  160  * This event provides a notification of when an application is installed.
  161  */
  162 //--------------------------------------------------------------------------------------------------
  163 le_instStat_AppInstallEventHandlerRef_t le_instStat_AddAppInstallEventHandler
  164 (
  165     le_instStat_AppInstallHandlerFunc_t handlerPtr,
  166         ///< [IN]
  167     void* contextPtr
  168         ///< [IN]
  169 );
  170 
  171 //--------------------------------------------------------------------------------------------------
  172 /**
  173  * Remove handler function for EVENT 'le_instStat_AppInstallEvent'
  174  */
  175 //--------------------------------------------------------------------------------------------------
  176 void le_instStat_RemoveAppInstallEventHandler
  177 (
  178     le_instStat_AppInstallEventHandlerRef_t handlerRef
  179         ///< [IN]
  180 );
  181 
  182 //--------------------------------------------------------------------------------------------------
  183 /**
  184  * Add handler function for EVENT 'le_instStat_AppUninstallEvent'
  185  *
  186  * This event provides a notification of when an application is uninstalled.
  187  */
  188 //--------------------------------------------------------------------------------------------------
  189 le_instStat_AppUninstallEventHandlerRef_t le_instStat_AddAppUninstallEventHandler
  190 (
  191     le_instStat_AppUninstallHandlerFunc_t handlerPtr,
  192         ///< [IN]
  193     void* contextPtr
  194         ///< [IN]
  195 );
  196 
  197 //--------------------------------------------------------------------------------------------------
  198 /**
  199  * Remove handler function for EVENT 'le_instStat_AppUninstallEvent'
  200  */
  201 //--------------------------------------------------------------------------------------------------
  202 void le_instStat_RemoveAppUninstallEventHandler
  203 (
  204     le_instStat_AppUninstallEventHandlerRef_t handlerRef
  205         ///< [IN]
  206 );
  207 
  208 /** @} **/
  209 
  210 #endif // LE_INSTSTAT_INTERFACE_H_INCLUDE_GUARD
le_instStat_TryConnectService
le_result_t le_instStat_TryConnectService(void)


le_instStat_AddAppUninstallEventHandler
le_instStat_AppUninstallEventHandlerRef_t le_instStat_AddAppUninstallEventHandler(le_instStat_AppUninstallHandlerFunc_t handlerPtr, void *contextPtr)


le_result_t
le_result_t
Definition: le_basics.h:46


le_instStat_ConnectService
void le_instStat_ConnectService(void)


le_instStat_RemoveAppUninstallEventHandler
void le_instStat_RemoveAppUninstallEventHandler(le_instStat_AppUninstallEventHandlerRef_t handlerRef)


le_instStat_AppInstallEventHandlerRef_t
struct le_instStat_AppInstallEventHandler * le_instStat_AppInstallEventHandlerRef_t
Definition: le_instStat_common.h:36


le_instStat_RemoveAppInstallEventHandler
void le_instStat_RemoveAppInstallEventHandler(le_instStat_AppInstallEventHandlerRef_t handlerRef)


le_instStat_AddAppInstallEventHandler
le_instStat_AppInstallEventHandlerRef_t le_instStat_AddAppInstallEventHandler(le_instStat_AppInstallHandlerFunc_t handlerPtr, void *contextPtr)


le_instStat_SetServerDisconnectHandler
LE_FULL_API void le_instStat_SetServerDisconnectHandler(le_instStat_DisconnectHandler_t disconnectHandler, void *contextPtr)


le_limit_interface.h


le_instStat_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_FULL_API
#define LE_FULL_API
Definition: le_apiFeatures.h:40



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


le_instStat_DisconnectHandler_t
void(* le_instStat_DisconnectHandler_t)(void *)
Definition: le_instStat_interface.h:51


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


le_instStat_DisconnectService
void le_instStat_DisconnectService(void)