5 * Copyright (C) 2007-2012 Intel Corporation. All rights reserved.
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.
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.
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
22 #ifndef __CONNMAN_PROVIDER_H
23 #define __CONNMAN_PROVIDER_H
26 #include <connman/types.h>
34 * @title: Provider premitives
35 * @short_description: Functions for handling providers
38 enum connman_provider_type {
39 CONNMAN_PROVIDER_TYPE_UNKNOWN = 0,
40 CONNMAN_PROVIDER_TYPE_VPN = 1,
43 enum connman_provider_state {
44 CONNMAN_PROVIDER_STATE_UNKNOWN = 0,
45 CONNMAN_PROVIDER_STATE_IDLE = 1,
46 CONNMAN_PROVIDER_STATE_CONNECT = 2,
47 CONNMAN_PROVIDER_STATE_READY = 3,
48 CONNMAN_PROVIDER_STATE_DISCONNECT = 4,
49 CONNMAN_PROVIDER_STATE_FAILURE = 5,
52 enum connman_provider_error {
53 CONNMAN_PROVIDER_ERROR_UNKNOWN = 0,
54 CONNMAN_PROVIDER_ERROR_CONNECT_FAILED = 1,
55 CONNMAN_PROVIDER_ERROR_LOGIN_FAILED = 2,
56 CONNMAN_PROVIDER_ERROR_AUTH_FAILED = 3,
59 enum connman_provider_route_type {
60 CONNMAN_PROVIDER_ROUTE_UNKNOWN = 0,
61 CONNMAN_PROVIDER_ROUTE_ALL = 0,
62 CONNMAN_PROVIDER_ROUTE_USER = 1,
63 CONNMAN_PROVIDER_ROUTE_SERVER = 2,
66 struct connman_provider;
67 struct connman_ipaddress;
69 #define connman_provider_ref(provider) \
70 connman_provider_ref_debug(provider, __FILE__, __LINE__, __func__)
72 #define connman_provider_unref(provider) \
73 connman_provider_unref_debug(provider, __FILE__, __LINE__, __func__)
75 struct connman_provider *
76 connman_provider_ref_debug(struct connman_provider *provider,
77 const char *file, int line, const char *caller);
78 void connman_provider_unref_debug(struct connman_provider *provider,
79 const char *file, int line, const char *caller);
81 int connman_provider_disconnect(struct connman_provider *provider);
82 int connman_provider_remove(struct connman_provider *provider);
84 int connman_provider_set_string(struct connman_provider *provider,
85 const char *key, const char *value);
86 const char *connman_provider_get_string(struct connman_provider *provider,
89 int connman_provider_set_state(struct connman_provider *provider,
90 enum connman_provider_state state);
92 int connman_provider_indicate_error(struct connman_provider *provider,
93 enum connman_provider_error error);
95 void connman_provider_set_index(struct connman_provider *provider, int index);
96 int connman_provider_get_index(struct connman_provider *provider);
98 void connman_provider_set_data(struct connman_provider *provider, void *data);
99 void *connman_provider_get_data(struct connman_provider *provider);
100 int connman_provider_set_ipaddress(struct connman_provider *provider,
101 struct connman_ipaddress *ipaddress);
102 int connman_provider_set_pac(struct connman_provider *provider,
104 int connman_provider_create_service(struct connman_provider *provider);
105 int connman_provider_set_immutable(struct connman_provider *provider,
106 connman_bool_t immutable);
107 struct connman_provider *connman_provider_get(const char *identifier);
108 void connman_provider_put(struct connman_provider *provider);
109 int connman_provider_set_domain(struct connman_provider *provider,
111 int connman_provider_set_nameservers(struct connman_provider *provider,
112 char * const *nameservers);
113 int connman_provider_append_route(struct connman_provider *provider,
114 const char *key, const char *value);
116 const char *connman_provider_get_driver_name(struct connman_provider *provider);
117 const char *connman_provider_get_save_group(struct connman_provider *provider);
118 typedef void (* connection_ready_cb) (DBusMessage *msg, int error_code,
121 struct connman_provider_driver {
123 enum connman_provider_type type;
124 int (*probe) (struct connman_provider *provider);
125 int (*remove) (struct connman_provider *provider);
126 int (*connect) (struct connman_provider *provider);
127 int (*disconnect) (struct connman_provider *provider);
128 int (*save) (struct connman_provider *provider, GKeyFile *keyfile);
129 int (*set_property) (struct connman_provider *provider,
130 const char *key, const char *value);
131 const char * (*get_property) (struct connman_provider *provider,
133 int (*create) (DBusMessage *msg, connection_ready_cb callback);
134 int (*set_routes) (struct connman_provider *provider,
135 enum connman_provider_route_type type);
136 connman_bool_t (*check_routes) (struct connman_provider *provider);
139 int connman_provider_driver_register(struct connman_provider_driver *driver);
140 void connman_provider_driver_unregister(struct connman_provider_driver *driver);
141 void connman_provider_set_driver(struct connman_provider *provider,
142 struct connman_provider_driver *driver);
148 #endif /* __CONNMAN_PROVIDER_H */