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