le_limit_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_limit Limit Definitions
14  *
15  * @ref le_limit_interface.h "API Reference"
16  *
17  * This file defines limit definitions used by other APIs.
18  *
19  * <HR>
20  *
21  * Copyright (C) Sierra Wireless Inc.
22  */
23 /**
24  * @file le_limit_interface.h
25  *
26  * Legato @ref c_limit include file.
27  *
28  * Copyright (C) Sierra Wireless Inc.
29  */
30 
31 #ifndef LE_LIMIT_INTERFACE_H_INCLUDE_GUARD
32 #define LE_LIMIT_INTERFACE_H_INCLUDE_GUARD
33 
34 
35 #include "legato.h"
36 
37 // Internal includes for this interface
38 #include "le_limit_common.h"
39 //--------------------------------------------------------------------------------------------------
40 /**
41  * Type for handler called when a server disconnects.
42  */
43 //--------------------------------------------------------------------------------------------------
44 typedef void (*le_limit_DisconnectHandler_t)(void *);
45 
46 //--------------------------------------------------------------------------------------------------
47 /**
48  *
49  * Connect the current client thread to the service providing this API. Block until the service is
50  * available.
51  *
52  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
53  * called before any other functions in this API. Normally, ConnectService is automatically called
54  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
55  *
56  * This function is created automatically.
57  */
58 //--------------------------------------------------------------------------------------------------
60 (
61  void
62 );
63 
64 //--------------------------------------------------------------------------------------------------
65 /**
66  *
67  * Try to connect the current client thread to the service providing this API. Return with an error
68  * if the service is not available.
69  *
70  * For each thread that wants to use this API, either ConnectService or TryConnectService must be
71  * called before any other functions in this API. Normally, ConnectService is automatically called
72  * for the main thread, but not for any other thread. For details, see @ref apiFilesC_client.
73  *
74  * This function is created automatically.
75  *
76  * @return
77  * - LE_OK if the client connected successfully to the service.
78  * - LE_UNAVAILABLE if the server is not currently offering the service to which the client is
79  * bound.
80  * - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
81  * - LE_COMM_ERROR if the Service Directory cannot be reached.
82  */
83 //--------------------------------------------------------------------------------------------------
85 (
86  void
87 );
88 
89 //--------------------------------------------------------------------------------------------------
90 /**
91  * Set handler called when server disconnection is detected.
92  *
93  * When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants
94  * to continue without exiting, it should call longjmp() from inside the handler.
95  */
96 //--------------------------------------------------------------------------------------------------
98 (
99  le_limit_DisconnectHandler_t disconnectHandler,
100  void *contextPtr
101 );
102 
103 //--------------------------------------------------------------------------------------------------
104 /**
105  *
106  * Disconnect the current client thread from the service providing this API.
107  *
108  * Normally, this function doesn't need to be called. After this function is called, there's no
109  * longer a connection to the service, and the functions in this API can't be used. For details, see
110  * @ref apiFilesC_client.
111  *
112  * This function is created automatically.
113  */
114 //--------------------------------------------------------------------------------------------------
116 (
117  void
118 );
119 
120 
121 #endif // LE_LIMIT_INTERFACE_H_INCLUDE_GUARD
void le_limit_ConnectService(void)
le_result_t
Definition: le_basics.h:35
LE_FULL_API void le_limit_SetServerDisconnectHandler(le_limit_DisconnectHandler_t disconnectHandler, void *contextPtr)
void le_limit_DisconnectService(void)
void(* le_limit_DisconnectHandler_t)(void *)
Definition: le_limit_interface.h:44
le_result_t le_limit_TryConnectService(void)
#define LE_FULL_API
Definition: le_basics.h:288