Add initial support for provider framework
[platform/upstream/connman.git] / include / provider.h
1 /*
2  *
3  *  Connection Manager
4  *
5  *  Copyright (C) 2007-2009  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_PROVIDER_H
23 #define __CONNMAN_PROVIDER_H
24
25 #include <connman/types.h>
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31 /**
32  * SECTION:provider
33  * @title: Provider premitives
34  * @short_description: Functions for handling providers
35  */
36
37 enum connman_provider_state {
38         CONNMAN_PROVIDER_STATE_UNKNOWN       = 0,
39         CONNMAN_PROVIDER_STATE_IDLE          = 1,
40         CONNMAN_PROVIDER_STATE_CONNECT       = 2,
41         CONNMAN_PROVIDER_STATE_READY         = 3,
42         CONNMAN_PROVIDER_STATE_DISCONNECT    = 4,
43         CONNMAN_PROVIDER_STATE_FAILURE       = 5,
44 };
45
46 enum connman_provider_error {
47         CONNMAN_PROVIDER_ERROR_UNKNOWN        = 0,
48         CONNMAN_PROVIDER_ERROR_CONNECT_FAILED = 1,
49 };
50
51
52 struct connman_provider;
53
54 struct connman_provider *connman_provider_ref(struct connman_provider *provider);
55 void connman_provider_unref(struct connman_provider *provider);
56
57 int connman_provider_set_string(struct connman_provider *provider,
58                                 const char *key, const char *value);
59 const char *connman_provider_get_string(struct connman_provider *provider,
60                                         const char *key);
61
62 int connman_provider_set_connected(struct connman_provider *provider,
63                                    connman_bool_t connected);
64
65 void connman_provider_set_index(struct connman_provider *provider, int index);
66 int connman_provider_get_index(struct connman_provider *provider);
67
68 void connman_provider_set_data(struct connman_provider *provider, void *data);
69 void *connman_provider_get_data(struct connman_provider *provider);
70
71 void connman_provider_set_gateway(struct connman_provider *provider,
72                                   const char *gateway);
73 void connman_provider_set_address(struct connman_provider *provider,
74                                   const char *address);
75 void connman_provider_set_netmask(struct connman_provider *provider,
76                                   const char *netmask);
77 void connman_provider_set_dns(struct connman_provider *provider,
78                               const char *dns);
79 void connman_provider_set_domain(struct connman_provider *provider,
80                                  const char *domain);
81
82
83 struct connman_provider_driver {
84         const char *name;
85         int (*probe) (struct connman_provider *provider);
86         int (*remove) (struct connman_provider *provider);
87         int (*connect) (struct connman_provider *provider);
88         int (*disconnect) (struct connman_provider *provider);
89 };
90
91 int connman_provider_driver_register(struct connman_provider_driver *driver);
92 void connman_provider_driver_unregister(struct connman_provider_driver *driver);
93
94 #ifdef __cplusplus
95 }
96 #endif
97
98 #endif /* __CONNMAN_PROVIDER_H */