service: Add getter for favorite flag
[platform/upstream/connman.git] / include / service.h
1 /*
2  *
3  *  Connection Manager
4  *
5  *  Copyright (C) 2007-2012  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 <connman/types.h>
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31 /**
32  * SECTION:service
33  * @title: Service premitives
34  * @short_description: Functions for handling services
35  */
36
37 enum connman_service_type {
38         CONNMAN_SERVICE_TYPE_UNKNOWN   = 0,
39         CONNMAN_SERVICE_TYPE_SYSTEM    = 1,
40         CONNMAN_SERVICE_TYPE_ETHERNET  = 2,
41         CONNMAN_SERVICE_TYPE_WIFI      = 3,
42         CONNMAN_SERVICE_TYPE_WIMAX     = 4,
43         CONNMAN_SERVICE_TYPE_BLUETOOTH = 5,
44         CONNMAN_SERVICE_TYPE_CELLULAR  = 6,
45         CONNMAN_SERVICE_TYPE_GPS       = 7,
46         CONNMAN_SERVICE_TYPE_VPN       = 8,
47         CONNMAN_SERVICE_TYPE_GADGET    = 9,
48 };
49
50 enum connman_service_security {
51         CONNMAN_SERVICE_SECURITY_UNKNOWN = 0,
52         CONNMAN_SERVICE_SECURITY_NONE    = 1,
53         CONNMAN_SERVICE_SECURITY_WEP     = 2,
54         CONNMAN_SERVICE_SECURITY_PSK     = 3,
55         CONNMAN_SERVICE_SECURITY_8021X   = 4,
56         CONNMAN_SERVICE_SECURITY_WPA     = 8,
57         CONNMAN_SERVICE_SECURITY_RSN     = 9,
58 };
59
60 enum connman_service_state {
61         CONNMAN_SERVICE_STATE_UNKNOWN       = 0,
62         CONNMAN_SERVICE_STATE_IDLE          = 1,
63         CONNMAN_SERVICE_STATE_ASSOCIATION   = 2,
64         CONNMAN_SERVICE_STATE_CONFIGURATION = 3,
65         CONNMAN_SERVICE_STATE_READY         = 4,
66         CONNMAN_SERVICE_STATE_ONLINE        = 5,
67         CONNMAN_SERVICE_STATE_DISCONNECT    = 6,
68         CONNMAN_SERVICE_STATE_FAILURE       = 7,
69 };
70
71 enum connman_service_error {
72         CONNMAN_SERVICE_ERROR_UNKNOWN        = 0,
73         CONNMAN_SERVICE_ERROR_OUT_OF_RANGE   = 1,
74         CONNMAN_SERVICE_ERROR_PIN_MISSING    = 2,
75         CONNMAN_SERVICE_ERROR_DHCP_FAILED    = 3,
76         CONNMAN_SERVICE_ERROR_CONNECT_FAILED = 4,
77         CONNMAN_SERVICE_ERROR_LOGIN_FAILED  = 5,
78         CONNMAN_SERVICE_ERROR_AUTH_FAILED    = 6,
79         CONNMAN_SERVICE_ERROR_INVALID_KEY    = 7,
80 };
81
82 enum connman_service_proxy_method {
83         CONNMAN_SERVICE_PROXY_METHOD_UNKNOWN     = 0,
84         CONNMAN_SERVICE_PROXY_METHOD_DIRECT      = 1,
85         CONNMAN_SERVICE_PROXY_METHOD_MANUAL      = 2,
86         CONNMAN_SERVICE_PROXY_METHOD_AUTO        = 3,
87 };
88
89 struct connman_service;
90 struct connman_network;
91
92 struct connman_service *connman_service_create(void);
93
94 #define connman_service_ref(service) \
95         connman_service_ref_debug(service, __FILE__, __LINE__, __func__)
96
97 #define connman_service_unref(service) \
98         connman_service_unref_debug(service, __FILE__, __LINE__, __func__)
99
100 struct connman_service *
101 connman_service_ref_debug(struct connman_service *service,
102                         const char *file, int line, const char *caller);
103 void connman_service_unref_debug(struct connman_service *service,
104                         const char *file, int line, const char *caller);
105
106 enum connman_service_type connman_service_get_type(struct connman_service *service);
107 char *connman_service_get_interface(struct connman_service *service);
108
109 const char *connman_service_get_domainname(struct connman_service *service);
110 char **connman_service_get_nameservers(struct connman_service *service);
111 char **connman_service_get_timeservers_config(struct connman_service *service);
112 char **connman_service_get_timeservers(struct connman_service *service);
113 void connman_service_set_proxy_method(struct connman_service *service, enum connman_service_proxy_method method);
114 enum connman_service_proxy_method connman_service_get_proxy_method(struct connman_service *service);
115 char **connman_service_get_proxy_servers(struct connman_service *service);
116 char **connman_service_get_proxy_excludes(struct connman_service *service);
117 const char *connman_service_get_proxy_url(struct connman_service *service);
118 const char *connman_service_get_proxy_autoconfig(struct connman_service *service);
119 connman_bool_t connman_service_get_favorite(struct connman_service *service);
120
121 struct connman_service *connman_service_lookup_from_network(struct connman_network *network);
122
123 void connman_service_create_ip4config(struct connman_service *service,
124                                                                 int index);
125 void connman_service_create_ip6config(struct connman_service *service,
126                                                                 int index);
127
128 #ifdef __cplusplus
129 }
130 #endif
131
132 #endif /* __CONNMAN_SERVICE_H */