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