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 
41 //--------------------------------------------------------------------------------------------------
42 /**
43  * Type for handler called when a server disconnects.
44  */
45 //--------------------------------------------------------------------------------------------------
46 typedef void (*le_instStat_DisconnectHandler_t)(void *);
47 
48 //--------------------------------------------------------------------------------------------------
49 /**
50  *
51  * Connect the current client thread to the service providing this API. Block until the service is
52  * available.
53  *
54  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
55  * called before any other functions in this API. Normally, ConnectService is automatically called
56  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
57  *
58  * This function is created automatically.
59  */
60 //--------------------------------------------------------------------------------------------------
62 (
63  void
64 );
65 
66 //--------------------------------------------------------------------------------------------------
67 /**
68  *
69  * Try to connect the current client thread to the service providing this API. Return with an error
70  * if the service is not available.
71  *
72  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
73  * called before any other functions in this API. Normally, ConnectService is automatically called
74  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
75  *
76  * This function is created automatically.
77  *
78  * @return
79  * - LE_OK if the client connected successfully to the service.
80  * - LE_UNAVAILABLE if the server is not currently offering the service to which the client is
81  * bound.
82  * - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
83  * - LE_COMM_ERROR if the Service Directory cannot be reached.
84  */
85 //--------------------------------------------------------------------------------------------------
87 (
88  void
89 );
90 
91 //--------------------------------------------------------------------------------------------------
92 /**
93  * Set handler called when server disconnection is detected.
94  *
95  * When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants
96  * to continue without exiting, it should call longjmp() from inside the handler.
97  */
98 //--------------------------------------------------------------------------------------------------
100 (
101  le_instStat_DisconnectHandler_t disconnectHandler,
102  void *contextPtr
103 );
104 
105 //--------------------------------------------------------------------------------------------------
106 /**
107  *
108  * Disconnect the current client thread from the service providing this API.
109  *
110  * Normally, this function doesn't need to be called. After this function is called, there's no
111  * longer a connection to the service, and the functions in this API can't be used. For details, see
112  * @ref apiFilesC_client.
113  *
114  * This function is created automatically.
115  */
116 //--------------------------------------------------------------------------------------------------
118 (
119  void
120 );
121 
122 
123 //--------------------------------------------------------------------------------------------------
124 /**
125  * Reference type used by Add/Remove functions for EVENT 'le_instStat_AppInstallEvent'
126  */
127 //--------------------------------------------------------------------------------------------------
128 typedef struct le_instStat_AppInstallEventHandler* le_instStat_AppInstallEventHandlerRef_t;
129 
130 
131 //--------------------------------------------------------------------------------------------------
132 /**
133  * Reference type used by Add/Remove functions for EVENT 'le_instStat_AppUninstallEvent'
134  */
135 //--------------------------------------------------------------------------------------------------
136 typedef struct le_instStat_AppUninstallEventHandler* le_instStat_AppUninstallEventHandlerRef_t;
137 
138 
139 //--------------------------------------------------------------------------------------------------
140 /**
141  * Handler for application install. Called when an application is installed.
142  */
143 //--------------------------------------------------------------------------------------------------
145 (
146  const char* LE_NONNULL appName,
147  ///< Name of the application installed.
148  void* contextPtr
149  ///<
150 );
151 
152 //--------------------------------------------------------------------------------------------------
153 /**
154  * Handler for application uninstall. Called when an application is uninstalled.
155  */
156 //--------------------------------------------------------------------------------------------------
158 (
159  const char* LE_NONNULL appName,
160  ///< Name of the application uninstalled.
161  void* contextPtr
162  ///<
163 );
164 
165 //--------------------------------------------------------------------------------------------------
166 /**
167  * Add handler function for EVENT 'le_instStat_AppInstallEvent'
168  *
169  * This event provides a notification of when an application is installed.
170  */
171 //--------------------------------------------------------------------------------------------------
173 (
175  ///< [IN]
176  void* contextPtr
177  ///< [IN]
178 );
179 
180 //--------------------------------------------------------------------------------------------------
181 /**
182  * Remove handler function for EVENT 'le_instStat_AppInstallEvent'
183  */
184 //--------------------------------------------------------------------------------------------------
186 (
188  ///< [IN]
189 );
190 
191 //--------------------------------------------------------------------------------------------------
192 /**
193  * Add handler function for EVENT 'le_instStat_AppUninstallEvent'
194  *
195  * This event provides a notification of when an application is uninstalled.
196  */
197 //--------------------------------------------------------------------------------------------------
199 (
201  ///< [IN]
202  void* contextPtr
203  ///< [IN]
204 );
205 
206 //--------------------------------------------------------------------------------------------------
207 /**
208  * Remove handler function for EVENT 'le_instStat_AppUninstallEvent'
209  */
210 //--------------------------------------------------------------------------------------------------
212 (
214  ///< [IN]
215 );
216 
217 #endif // LE_INSTSTAT_INTERFACE_H_INCLUDE_GUARD
void le_instStat_DisconnectService(void)
void le_instStat_ConnectService(void)
void le_instStat_RemoveAppUninstallEventHandler(le_instStat_AppUninstallEventHandlerRef_t handlerRef)
le_result_t
Definition: le_basics.h:35
le_result_t le_instStat_TryConnectService(void)
void le_instStat_RemoveAppInstallEventHandler(le_instStat_AppInstallEventHandlerRef_t handlerRef)
struct le_instStat_AppInstallEventHandler * le_instStat_AppInstallEventHandlerRef_t
Definition: le_instStat_interface.h:128
le_instStat_AppInstallEventHandlerRef_t le_instStat_AddAppInstallEventHandler(le_instStat_AppInstallHandlerFunc_t handlerPtr, void *contextPtr)
void le_instStat_SetServerDisconnectHandler(le_instStat_DisconnectHandler_t disconnectHandler, void *contextPtr)
void(* le_instStat_AppInstallHandlerFunc_t)(const char *LE_NONNULL appName, void *contextPtr)
Definition: le_instStat_interface.h:145
struct le_instStat_AppUninstallEventHandler * le_instStat_AppUninstallEventHandlerRef_t
Definition: le_instStat_interface.h:136
void(* le_instStat_AppUninstallHandlerFunc_t)(const char *LE_NONNULL appName, void *contextPtr)
Definition: le_instStat_interface.h:158
void(* le_instStat_DisconnectHandler_t)(void *)
Definition: le_instStat_interface.h:46
le_instStat_AppUninstallEventHandlerRef_t le_instStat_AddAppUninstallEventHandler(le_instStat_AppUninstallHandlerFunc_t handlerPtr, void *contextPtr)