le_posCtrl_common.h

Go to the documentation of this file.
1 
2 /*
3  * ====================== WARNING ======================
4  *
5  * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
6  * DO NOT MODIFY IN ANY WAY.
7  *
8  * ====================== WARNING ======================
9  */
10 /**
11  * @file le_posCtrl_common.h
12  *
13  * Type definitions for le_posCtrl.
14  *
15  */
16 #ifndef LE_POSCTRL_COMMON_H_INCLUDE_GUARD
17 #define LE_POSCTRL_COMMON_H_INCLUDE_GUARD
18 
19 
20 #include "legato.h"
21 
22 #define IFGEN_LE_POSCTRL_PROTOCOL_ID "d47cc30512e69387f546399a44c565e4"
23 #define IFGEN_LE_POSCTRL_MSG_SIZE 12
24 /** @addtogroup le_posCtrl
25  * @{ **/
26 
27 
28 //--------------------------------------------------------------------------------------------------
29 /**
30  * Reference type for dealing with Position Service management.
31  */
32 //--------------------------------------------------------------------------------------------------
33 typedef struct le_posCtrl_Activation* le_posCtrl_ActivationRef_t;
34 
35 
36 
37 //--------------------------------------------------------------------------------------------------
38 /**
39  * Get if this client bound locally.
40  */
41 //--------------------------------------------------------------------------------------------------
42 LE_SHARED bool ifgen_le_posCtrl_HasLocalBinding
43 (
44  void
45 );
46 
47 
48 //--------------------------------------------------------------------------------------------------
49 /**
50  * Init data that is common across all threads
51  */
52 //--------------------------------------------------------------------------------------------------
53 LE_SHARED void ifgen_le_posCtrl_InitCommonData
54 (
55  void
56 );
57 
58 
59 //--------------------------------------------------------------------------------------------------
60 /**
61  * Perform common initialization and open a session
62  */
63 //--------------------------------------------------------------------------------------------------
64 LE_SHARED le_result_t ifgen_le_posCtrl_OpenSession
65 (
66  le_msg_SessionRef_t _ifgen_sessionRef,
67  bool isBlocking
68 );
69 
70 //--------------------------------------------------------------------------------------------------
71 /**
72  * Request activation of the positioning service.
73  *
74  * @return
75  * - Reference to the service activation request (to be used later for releasing the request).
76  * - NULL if the service request could not be processed.
77  *
78  */
79 //--------------------------------------------------------------------------------------------------
80 LE_SHARED le_posCtrl_ActivationRef_t ifgen_le_posCtrl_Request
81 (
82  le_msg_SessionRef_t _ifgen_sessionRef
83 );
84 
85 //--------------------------------------------------------------------------------------------------
86 /**
87  * Release the positioning service.
88  *
89  */
90 //--------------------------------------------------------------------------------------------------
91 LE_SHARED void ifgen_le_posCtrl_Release
92 (
93  le_msg_SessionRef_t _ifgen_sessionRef,
95  ///< [IN] Reference to a positioning service activation request.
96 );
97 /** @} **/
98 #endif // LE_POSCTRL_COMMON_H_INCLUDE_GUARD
#define LE_SHARED
Definition: le_basics.h:287
le_result_t
Definition: le_basics.h:46
struct le_posCtrl_Activation * le_posCtrl_ActivationRef_t
Definition: le_posCtrl_common.h:33
struct le_msg_Session * le_msg_SessionRef_t
Definition: le_messaging.h:860