Maintain connection status when wifi roaming
[platform/upstream/connman.git] / include / service.h
1 /*
2  *
3  *  Connection Manager
4  *
5  *  Copyright (C) 2007-2014  Intel Corporation. All rights reserved.
6  *
7  *  This program is free software; you can redistribute it and/or modify
8  *  it under the terms of the GNU General Public License version 2 as
9  *  published by the Free Software Foundation.
10  *
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program; if not, write to the Free Software
18  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  */
21
22 #ifndef __CONNMAN_SERVICE_H
23 #define __CONNMAN_SERVICE_H
24
25 #include <stdbool.h>
26
27 #if defined TIZEN_EXT
28 #include <glib.h>
29 #include <gdbus.h>
30 #endif
31
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35
36 /**
37  * SECTION:service
38  * @title: Service premitives
39  * @short_description: Functions for handling services
40  */
41
42 enum connman_service_type {
43         CONNMAN_SERVICE_TYPE_UNKNOWN   = 0,
44         CONNMAN_SERVICE_TYPE_SYSTEM    = 1,
45         CONNMAN_SERVICE_TYPE_ETHERNET  = 2,
46         CONNMAN_SERVICE_TYPE_WIFI      = 3,
47         CONNMAN_SERVICE_TYPE_BLUETOOTH = 4,
48         CONNMAN_SERVICE_TYPE_CELLULAR  = 5,
49         CONNMAN_SERVICE_TYPE_GPS       = 6,
50         CONNMAN_SERVICE_TYPE_VPN       = 7,
51         CONNMAN_SERVICE_TYPE_GADGET    = 8,
52         CONNMAN_SERVICE_TYPE_P2P       = 9,
53 #if defined TIZEN_EXT_WIFI_MESH
54         CONNMAN_SERVICE_TYPE_MESH      = 10,
55 #endif
56 };
57 #if defined TIZEN_EXT_WIFI_MESH
58 #define MAX_CONNMAN_SERVICE_TYPES        11
59 #else
60 #define MAX_CONNMAN_SERVICE_TYPES        10
61 #endif
62
63
64 enum connman_service_security {
65         CONNMAN_SERVICE_SECURITY_UNKNOWN = 0,
66         CONNMAN_SERVICE_SECURITY_NONE    = 1,
67         CONNMAN_SERVICE_SECURITY_WEP     = 2,
68         CONNMAN_SERVICE_SECURITY_PSK     = 3,
69         CONNMAN_SERVICE_SECURITY_8021X   = 4,
70         CONNMAN_SERVICE_SECURITY_WPA     = 8,
71         CONNMAN_SERVICE_SECURITY_RSN     = 9,
72 #if defined TIZEN_EXT
73         CONNMAN_SERVICE_SECURITY_SAE     = 10,
74         CONNMAN_SERVICE_SECURITY_OWE     = 11,
75         CONNMAN_SERVICE_SECURITY_DPP     = 12,
76 #endif
77 #if defined TIZEN_EXT
78         CONNMAN_SERVICE_SECURITY_MAX
79 #endif
80 };
81
82 enum connman_service_state {
83         CONNMAN_SERVICE_STATE_UNKNOWN       = 0,
84         CONNMAN_SERVICE_STATE_IDLE          = 1,
85         CONNMAN_SERVICE_STATE_ASSOCIATION   = 2,
86         CONNMAN_SERVICE_STATE_CONFIGURATION = 3,
87         CONNMAN_SERVICE_STATE_READY         = 4,
88         CONNMAN_SERVICE_STATE_ONLINE        = 5,
89         CONNMAN_SERVICE_STATE_DISCONNECT    = 6,
90         CONNMAN_SERVICE_STATE_FAILURE       = 7,
91 };
92
93 enum connman_service_error {
94         CONNMAN_SERVICE_ERROR_UNKNOWN        = 0,
95         CONNMAN_SERVICE_ERROR_OUT_OF_RANGE   = 1,
96         CONNMAN_SERVICE_ERROR_PIN_MISSING    = 2,
97         CONNMAN_SERVICE_ERROR_DHCP_FAILED    = 3,
98         CONNMAN_SERVICE_ERROR_CONNECT_FAILED = 4,
99         CONNMAN_SERVICE_ERROR_LOGIN_FAILED  = 5,
100         CONNMAN_SERVICE_ERROR_AUTH_FAILED    = 6,
101         CONNMAN_SERVICE_ERROR_INVALID_KEY    = 7,
102         CONNMAN_SERVICE_ERROR_BLOCKED        = 8,
103 #if defined TIZEN_EXT
104         CONNMAN_SERVICE_ERROR_ASSOC_FAILED   = 9,
105 #endif
106 };
107
108 enum connman_service_proxy_method {
109         CONNMAN_SERVICE_PROXY_METHOD_UNKNOWN     = 0,
110         CONNMAN_SERVICE_PROXY_METHOD_DIRECT      = 1,
111         CONNMAN_SERVICE_PROXY_METHOD_MANUAL      = 2,
112         CONNMAN_SERVICE_PROXY_METHOD_AUTO        = 3,
113 };
114
115 enum connman_service_connect_reason {
116         CONNMAN_SERVICE_CONNECT_REASON_NONE     = 0,
117         CONNMAN_SERVICE_CONNECT_REASON_AUTO     = 1,
118         CONNMAN_SERVICE_CONNECT_REASON_USER     = 2,
119         CONNMAN_SERVICE_CONNECT_REASON_SESSION  = 3,
120         CONNMAN_SERVICE_CONNECT_REASON_NATIVE   = 4,
121 };
122
123 struct connman_service;
124 struct connman_network;
125
126 struct connman_service *connman_service_create(void);
127
128 #define connman_service_ref(service) \
129         connman_service_ref_debug(service, __FILE__, __LINE__, __func__)
130
131 #define connman_service_unref(service) \
132         connman_service_unref_debug(service, __FILE__, __LINE__, __func__)
133
134 struct connman_service *
135 connman_service_ref_debug(struct connman_service *service,
136                         const char *file, int line, const char *caller);
137 void connman_service_unref_debug(struct connman_service *service,
138                         const char *file, int line, const char *caller);
139
140 enum connman_service_type connman_service_get_type(struct connman_service *service);
141 enum connman_service_state connman_service_get_state(struct connman_service *service);
142 char *connman_service_get_interface(struct connman_service *service);
143
144 const char *connman_service_get_identifier(struct connman_service *service);
145 const char *connman_service_get_domainname(struct connman_service *service);
146 const char *connman_service_get_dbuspath(struct connman_service *service);
147 char **connman_service_get_nameservers(struct connman_service *service);
148 char **connman_service_get_timeservers_config(struct connman_service *service);
149 char **connman_service_get_timeservers(struct connman_service *service);
150 void connman_service_set_proxy_method(struct connman_service *service, enum connman_service_proxy_method method);
151 enum connman_service_proxy_method connman_service_get_proxy_method(struct connman_service *service);
152 char **connman_service_get_proxy_servers(struct connman_service *service);
153 char **connman_service_get_proxy_excludes(struct connman_service *service);
154 const char *connman_service_get_proxy_url(struct connman_service *service);
155 const char *connman_service_get_proxy_autoconfig(struct connman_service *service);
156 bool connman_service_get_favorite(struct connman_service *service);
157 bool connman_service_get_autoconnect(struct connman_service *service);
158 bool connman_service_set_autoconnect(struct connman_service *service,
159                                                         bool autoconnect);
160
161 /* Return non-zero value to terminate the loop, zero to continue */
162 typedef int (* connman_service_iterate_cb) (struct connman_service *service,
163                                                         void *user_data);
164 int connman_service_iterate_services(connman_service_iterate_cb cb,
165                                                         void *user_data);
166
167 struct connman_service *connman_service_get_default(void);
168 struct connman_service *connman_service_lookup_from_network(struct connman_network *network);
169 struct connman_service *connman_service_lookup_from_identifier(const char* identifier);
170
171 void connman_service_create_ip4config(struct connman_service *service,
172                                                                 int index);
173 void connman_service_create_ip6config(struct connman_service *service,
174                                                                 int index);
175
176 #if defined TIZEN_EXT
177 /*
178  * Description: TIZEN implements system global connection management.
179  *              It's only for PDP (cellular) bearer. Wi-Fi is managed by ConnMan automatically.
180  *              Reference count can help to manage open/close connection requests by each application.
181  */
182
183 /*
184  * Increase reference count of user-initiated packet data network connection
185  */
186 void connman_service_user_pdn_connection_ref(struct connman_service *service);
187
188 /*
189  * Decrease reference count of user initiated packet data network connection
190  * and return TRUE if counter is zero.
191  */
192 gboolean connman_service_user_pdn_connection_unref_and_test(
193                                         struct connman_service *service);
194
195 /*
196  * Test reference count of user initiated packet data network connection
197  * and return TRUE if counter is zero. No impact to reference count
198  */
199 gboolean connman_service_is_no_ref_user_pdn_connection(
200                                         struct connman_service *service);
201
202 struct connman_service *connman_service_get_default_connection(void);
203 struct connman_service *connman_service_get_connected_service(const char *ifname);
204
205 /*
206  * Description: telephony plug-in requires manual PROXY setting
207  */
208 int connman_service_set_proxy(struct connman_service *service,
209                                         const char *proxy, gboolean active);
210
211 void connman_service_set_disconnection_requested(struct connman_service *service,
212                                                 bool disconnection_requested);
213 void connman_service_notify_reconnection(struct connman_service *service);
214 #endif
215
216 #if defined TIZEN_EXT
217 void connman_service_set_internet_connection(struct connman_service *service,
218                                                         bool internet_connection);
219 bool connman_service_get_internet_connection(struct connman_service *service);
220 DBusMessage *connman_service_create_dbus_service_reply(DBusMessage *msg,
221                                                         struct connman_service *service);
222 #endif
223
224 #ifdef __cplusplus
225 }
226 #endif
227
228 #endif /* __CONNMAN_SERVICE_H */