le_instStat_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_le_instStat Install Status API
   12  *
   13  * @ref le_instStat_interface.h "API Reference"
   14  *
   15  * This API provides notifications when apps are installed and uninstalled.
   16  *
   17  * <HR>
   18  *
   19  * Copyright (C) Sierra Wireless Inc. Use of this work is subject to license.
   20  */
   21 /**
   22  * @file le_instStat_interface.h
   23  *
   24  * Legato @ref c_le_instStat include file.
   25  *
   26  * Copyright (C) Sierra Wireless Inc. Use of this work is subject to license.
   27  */
   28 
   29 #ifndef LE_INSTSTAT_INTERFACE_H_INCLUDE_GUARD
   30 #define LE_INSTSTAT_INTERFACE_H_INCLUDE_GUARD
   31 
   32 
   33 #include "legato.h"
   34 
   35 // Interface specific includes
   36 #include "le_limit_interface.h"
   37 
   38 
   39 //--------------------------------------------------------------------------------------------------
   40 /**
   41  *
   42  * Connect the current client thread to the service providing this API. Block until the service is
   43  * available.
   44  *
   45  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
   46  * called before any other functions in this API.  Normally, ConnectService is automatically called
   47  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
   48  *
   49  * This function is created automatically.
   50  */
   51 //--------------------------------------------------------------------------------------------------
   52 void le_instStat_ConnectService
   53 (
   54     void
   55 );
   56 
   57 //--------------------------------------------------------------------------------------------------
   58 /**
   59  *
   60  * Try to connect the current client thread to the service providing this API. Return with an error
   61  * if the service is not available.
   62  *
   63  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
   64  * called before any other functions in this API.  Normally, ConnectService is automatically called
   65  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
   66  *
   67  * This function is created automatically.
   68  *
   69  * @return
   70  *  - LE_OK if the client connected successfully to the service.
   71  *  - LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
   72  *  - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
   73  *  - LE_COMM_ERROR if the Service Directory cannot be reached.
   74  */
   75 //--------------------------------------------------------------------------------------------------
   76 le_result_t le_instStat_TryConnectService
   77 (
   78     void
   79 );
   80 
   81 //--------------------------------------------------------------------------------------------------
   82 /**
   83  *
   84  * Disconnect the current client thread from the service providing this API.
   85  *
   86  * Normally, this function doesn't need to be called. After this function is called, there's no
   87  * longer a connection to the service, and the functions in this API can't be used. For details, see
   88  * @ref apiFilesC_client.
   89  *
   90  * This function is created automatically.
   91  */
   92 //--------------------------------------------------------------------------------------------------
   93 void le_instStat_DisconnectService
   94 (
   95     void
   96 );
   97 
   98 
   99 //--------------------------------------------------------------------------------------------------
  100 /**
  101  * Reference type used by Add/Remove functions for EVENT 'le_instStat_AppInstallEvent'
  102  */
  103 //--------------------------------------------------------------------------------------------------
  104 typedef struct le_instStat_AppInstallEventHandler* le_instStat_AppInstallEventHandlerRef_t;
  105 
  106 
  107 //--------------------------------------------------------------------------------------------------
  108 /**
  109  * Reference type used by Add/Remove functions for EVENT 'le_instStat_AppUninstallEvent'
  110  */
  111 //--------------------------------------------------------------------------------------------------
  112 typedef struct le_instStat_AppUninstallEventHandler* le_instStat_AppUninstallEventHandlerRef_t;
  113 
  114 
  115 //--------------------------------------------------------------------------------------------------
  116 /**
  117  * Handler for application install.  Called when an application is installed.
  118  *
  119  * @param appName
  120  *        Name of the application installed.
  121  * @param contextPtr
  122  */
  123 //--------------------------------------------------------------------------------------------------
  124 typedef void (*le_instStat_AppInstallHandlerFunc_t)
  125 (
  126     const char* appName,
  127     void* contextPtr
  128 );
  129 
  130 
  131 //--------------------------------------------------------------------------------------------------
  132 /**
  133  * Handler for application uninstall.  Called when an application is uninstalled.
  134  *
  135  * @param appName
  136  *        Name of the application uninstalled.
  137  * @param contextPtr
  138  */
  139 //--------------------------------------------------------------------------------------------------
  140 typedef void (*le_instStat_AppUninstallHandlerFunc_t)
  141 (
  142     const char* appName,
  143     void* contextPtr
  144 );
  145 
  146 //--------------------------------------------------------------------------------------------------
  147 /**
  148  * Add handler function for EVENT 'le_instStat_AppInstallEvent'
  149  *
  150  * This event provides a notification of when an application is installed.
  151  */
  152 //--------------------------------------------------------------------------------------------------
  153 le_instStat_AppInstallEventHandlerRef_t le_instStat_AddAppInstallEventHandler
  154 (
  155     le_instStat_AppInstallHandlerFunc_t handlerPtr,
  156         ///< [IN]
  157 
  158     void* contextPtr
  159         ///< [IN]
  160 );
  161 
  162 //--------------------------------------------------------------------------------------------------
  163 /**
  164  * Remove handler function for EVENT 'le_instStat_AppInstallEvent'
  165  */
  166 //--------------------------------------------------------------------------------------------------
  167 void le_instStat_RemoveAppInstallEventHandler
  168 (
  169     le_instStat_AppInstallEventHandlerRef_t addHandlerRef
  170         ///< [IN]
  171 );
  172 
  173 //--------------------------------------------------------------------------------------------------
  174 /**
  175  * Add handler function for EVENT 'le_instStat_AppUninstallEvent'
  176  *
  177  * This event provides a notification of when an application is uninstalled.
  178  */
  179 //--------------------------------------------------------------------------------------------------
  180 le_instStat_AppUninstallEventHandlerRef_t le_instStat_AddAppUninstallEventHandler
  181 (
  182     le_instStat_AppUninstallHandlerFunc_t handlerPtr,
  183         ///< [IN]
  184 
  185     void* contextPtr
  186         ///< [IN]
  187 );
  188 
  189 //--------------------------------------------------------------------------------------------------
  190 /**
  191  * Remove handler function for EVENT 'le_instStat_AppUninstallEvent'
  192  */
  193 //--------------------------------------------------------------------------------------------------
  194 void le_instStat_RemoveAppUninstallEventHandler
  195 (
  196     le_instStat_AppUninstallEventHandlerRef_t addHandlerRef
  197         ///< [IN]
  198 );
  199 
  200 
  201 #endif // LE_INSTSTAT_INTERFACE_H_INCLUDE_GUARD
  202 
le_result_t
le_result_t
Definition: le_basics.h:35
le_instStat_DisconnectService
void le_instStat_DisconnectService(void)
le_instStat_AddAppInstallEventHandler
le_instStat_AppInstallEventHandlerRef_t le_instStat_AddAppInstallEventHandler(le_instStat_AppInstallHandlerFunc_t handlerPtr, void *contextPtr)
le_instStat_AppInstallEventHandlerRef_t
struct le_instStat_AppInstallEventHandler * le_instStat_AppInstallEventHandlerRef_t
Definition: le_instStat_interface.h:104
le_instStat_AppUninstallEventHandlerRef_t
struct le_instStat_AppUninstallEventHandler * le_instStat_AppUninstallEventHandlerRef_t
Definition: le_instStat_interface.h:112
le_limit_interface.h
le_instStat_TryConnectService
le_result_t le_instStat_TryConnectService(void)
legato.h
le_instStat_RemoveAppUninstallEventHandler
void le_instStat_RemoveAppUninstallEventHandler(le_instStat_AppUninstallEventHandlerRef_t addHandlerRef)
le_instStat_AppUninstallHandlerFunc_t
void(* le_instStat_AppUninstallHandlerFunc_t)(const char *appName, void *contextPtr)
Definition: le_instStat_interface.h:141
le_instStat_AddAppUninstallEventHandler
le_instStat_AppUninstallEventHandlerRef_t le_instStat_AddAppUninstallEventHandler(le_instStat_AppUninstallHandlerFunc_t handlerPtr, void *contextPtr)
le_instStat_ConnectService
void le_instStat_ConnectService(void)
le_instStat_RemoveAppInstallEventHandler
void le_instStat_RemoveAppInstallEventHandler(le_instStat_AppInstallEventHandlerRef_t addHandlerRef)
le_instStat_AppInstallHandlerFunc_t
void(* le_instStat_AppInstallHandlerFunc_t)(const char *appName, void *contextPtr)
Definition: le_instStat_interface.h:125