Ubuntu Platform API  1.0.0
A library helping with tight integration into the Ubuntu platform
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
session.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2013 Canonical Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License version 3 as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Thomas Voß <thomas.voss@canonical.com>
17  */
18 
19 #ifndef UBUNTU_APPLICATION_LOCATION_SESSION_H_
20 #define UBUNTU_APPLICATION_LOCATION_SESSION_H_
21 
22 #include <ubuntu/status.h>
23 #include <ubuntu/visibility.h>
24 
25 #include <ubuntu/application/location/heading_update.h>
26 #include <ubuntu/application/location/position_update.h>
27 #include <ubuntu/application/location/velocity_update.h>
28 
29 #ifdef __cplusplus
30 extern "C"
31 {
32 #endif
33 
38  typedef struct UbuntuApplicationLocationServiceSession UALocationServiceSession;
39 
44  typedef void (*UALocationServiceSessionPositionUpdatesHandler)(
45  UALocationPositionUpdate *position,
46  void *context);
47 
52  typedef void (*UALocationServiceSessionHeadingUpdatesHandler)(
53  UALocationHeadingUpdate *heading,
54  void *context);
55 
60  typedef void (*UALocationServiceSessionVelocityUpdatesHandler)(
61  UALocationVelocityUpdate *heading,
62  void *context);
63 
69  UBUNTU_DLL_PUBLIC void
70  ua_location_service_session_ref(
71  UALocationServiceSession *session);
72 
78  UBUNTU_DLL_PUBLIC void
79  ua_location_service_session_unref(
80  UALocationServiceSession *session);
81 
88  UBUNTU_DLL_PUBLIC void
89  ua_location_service_session_set_position_updates_handler(
90  UALocationServiceSession *session,
91  UALocationServiceSessionPositionUpdatesHandler handler,
92  void *context);
93 
100  UBUNTU_DLL_PUBLIC void
101  ua_location_service_session_set_heading_updates_handler(
102  UALocationServiceSession *session,
103  UALocationServiceSessionHeadingUpdatesHandler handler,
104  void *context);
105 
112  UBUNTU_DLL_PUBLIC void
113  ua_location_service_session_set_velocity_updates_handler(
114  UALocationServiceSession *session,
115  UALocationServiceSessionVelocityUpdatesHandler handler,
116  void *context);
117 
124  UBUNTU_DLL_PUBLIC UStatus
125  ua_location_service_session_start_position_updates(
126  UALocationServiceSession *session);
127 
133  UBUNTU_DLL_PUBLIC void
134  ua_location_service_session_stop_position_updates(
135  UALocationServiceSession *session);
136 
143  UBUNTU_DLL_PUBLIC UStatus
144  ua_location_service_session_start_heading_updates(
145  UALocationServiceSession *session);
146 
152  UBUNTU_DLL_PUBLIC void
153  ua_location_service_session_stop_heading_updates(
154  UALocationServiceSession *session);
155 
162  UBUNTU_DLL_PUBLIC UStatus
163  ua_location_service_session_start_velocity_updates(
164  UALocationServiceSession *session);
165 
171  UBUNTU_DLL_PUBLIC void
172  ua_location_service_session_stop_velocity_updates(
173  UALocationServiceSession *session);
174 
175 #ifdef __cplusplus
176 }
177 #endif
178 
179 #endif // UBUNTU_APPLICATION_LOCATION_SESSION_H_