Use priority and strength to select known network
[connman] / include / network.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_NETWORK_H
23 #define __CONNMAN_NETWORK_H
24
25 #include <connman/types.h>
26 #include <connman/device.h>
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 /**
33  * SECTION:network
34  * @title: Network premitives
35  * @short_description: Functions for handling networks
36  */
37
38 enum connman_network_type {
39         CONNMAN_NETWORK_TYPE_UNKNOWN       = 0,
40         CONNMAN_NETWORK_TYPE_WIFI          = 1,
41         CONNMAN_NETWORK_TYPE_BLUETOOTH_PAN = 8,
42         CONNMAN_NETWORK_TYPE_BLUETOOTH_DUN = 9,
43         CONNMAN_NETWORK_TYPE_HSO           = 23,
44         CONNMAN_NETWORK_TYPE_VENDOR        = 10000,
45 };
46
47 enum connman_network_protocol {
48         CONNMAN_NETWORK_PROTOCOL_UNKNOWN = 0,
49         CONNMAN_NETWORK_PROTOCOL_IP      = 1,
50         CONNMAN_NETWORK_PROTOCOL_PPP     = 2,
51 };
52
53 struct connman_network;
54
55 extern struct connman_network *connman_network_create(const char *identifier,
56                                                 enum connman_network_type type);
57 extern struct connman_network *connman_network_ref(struct connman_network *network);
58 extern void connman_network_unref(struct connman_network *network);
59
60 extern const char *connman_network_get_identifier(struct connman_network *network);
61
62 extern const char *connman_network_get_path(struct connman_network *network);
63 extern void connman_network_set_index(struct connman_network *network,
64                                                                 int index);
65 extern int connman_network_get_index(struct connman_network *network);
66
67 extern void connman_network_set_protocol(struct connman_network *network,
68                                         enum connman_network_protocol protocol);
69
70 extern int connman_network_set_available(struct connman_network *network,
71                                                 connman_bool_t available);
72 extern connman_bool_t connman_network_get_available(struct connman_network *network);
73 extern int connman_network_set_connected(struct connman_network *network,
74                                                 connman_bool_t connected);
75 extern int connman_network_set_remember(struct connman_network *network,
76                                                 connman_bool_t remember);
77 extern connman_bool_t connman_network_get_remember(struct connman_network *network);
78
79 extern int connman_network_connect(struct connman_network *network);
80
81 extern int connman_network_set_string(struct connman_network *network,
82                                         const char *key, const char *value);
83 extern const char *connman_network_get_string(struct connman_network *network,
84                                                         const char *key);
85 extern int connman_network_set_uint8(struct connman_network *network,
86                                         const char *key, connman_uint8_t value);
87 extern connman_uint8_t connman_network_get_uint8(struct connman_network *network,
88                                                         const char *key);
89 extern int connman_network_set_blob(struct connman_network *network,
90                         const char *key, const void *data, unsigned int size);
91 extern const void *connman_network_get_blob(struct connman_network *network,
92                                         const char *key, unsigned int *size);
93
94 extern struct connman_device *connman_network_get_device(struct connman_network *network);
95
96 extern void *connman_network_get_data(struct connman_network *network);
97 extern void connman_network_set_data(struct connman_network *network, void *data);
98
99 struct connman_network_driver {
100         const char *name;
101         enum connman_network_type type;
102         int priority;
103         int (*probe) (struct connman_network *network);
104         void (*remove) (struct connman_network *network);
105         int (*connect) (struct connman_network *network);
106         int (*disconnect) (struct connman_network *network);
107 };
108
109 extern int connman_network_driver_register(struct connman_network_driver *driver);
110 extern void connman_network_driver_unregister(struct connman_network_driver *driver);
111
112 #ifdef __cplusplus
113 }
114 #endif
115
116 #endif /* __CONNMAN_NETWORK_H */