Add function to retrieve network association state
[platform/upstream/connman.git] / 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_WIMAX         = 2,
42         CONNMAN_NETWORK_TYPE_BLUETOOTH_PAN = 8,
43         CONNMAN_NETWORK_TYPE_BLUETOOTH_DUN = 9,
44         CONNMAN_NETWORK_TYPE_MBM           = 22,
45         CONNMAN_NETWORK_TYPE_HSO           = 23,
46         CONNMAN_NETWORK_TYPE_VENDOR        = 10000,
47 };
48
49 enum connman_network_protocol {
50         CONNMAN_NETWORK_PROTOCOL_UNKNOWN = 0,
51         CONNMAN_NETWORK_PROTOCOL_IP      = 1,
52         CONNMAN_NETWORK_PROTOCOL_PPP     = 2,
53 };
54
55 struct connman_network;
56
57 struct connman_network *connman_network_create(const char *identifier,
58                                         enum connman_network_type type);
59 struct connman_network *connman_network_ref(struct connman_network *network);
60 void connman_network_unref(struct connman_network *network);
61
62 enum connman_network_type connman_network_get_type(struct connman_network *network);
63 const char *connman_network_get_identifier(struct connman_network *network);
64
65 const char *connman_network_get_path(struct connman_network *network);
66 void connman_network_set_index(struct connman_network *network, int index);
67 int connman_network_get_index(struct connman_network *network);
68
69 void connman_network_set_protocol(struct connman_network *network,
70                                         enum connman_network_protocol protocol);
71 void connman_network_set_group(struct connman_network *network,
72                                                 const char *group);
73 const char *connman_network_get_group(struct connman_network *network);
74
75 int connman_network_set_available(struct connman_network *network,
76                                                 connman_bool_t available);
77 connman_bool_t connman_network_get_available(struct connman_network *network);
78 int connman_network_set_associating(struct connman_network *network,
79                                                 connman_bool_t associating);
80 int connman_network_set_connected(struct connman_network *network,
81                                                 connman_bool_t connected);
82 connman_bool_t connman_network_get_connected(struct connman_network *network);
83
84 connman_bool_t connman_network_get_associating(struct connman_network *network);
85
86 int connman_network_set_address(struct connman_network *network,
87                                 const void *address, unsigned int size);
88 int connman_network_set_name(struct connman_network *network,
89                                                         const char *name);
90 int connman_network_set_strength(struct connman_network *network,
91                                                 connman_uint8_t strength);
92
93 int connman_network_set_string(struct connman_network *network,
94                                         const char *key, const char *value);
95 const char *connman_network_get_string(struct connman_network *network,
96                                                         const char *key);
97 int connman_network_set_uint8(struct connman_network *network,
98                                         const char *key, connman_uint8_t value);
99 connman_uint8_t connman_network_get_uint8(struct connman_network *network,
100                                                         const char *key);
101 int connman_network_set_uint16(struct connman_network *network,
102                                         const char *key, connman_uint16_t value);
103 connman_uint16_t connman_network_get_uint16(struct connman_network *network,
104                                                         const char *key);
105 int connman_network_set_blob(struct connman_network *network,
106                         const char *key, const void *data, unsigned int size);
107 const void *connman_network_get_blob(struct connman_network *network,
108                                         const char *key, unsigned int *size);
109
110 struct connman_device *connman_network_get_device(struct connman_network *network);
111
112 void *connman_network_get_data(struct connman_network *network);
113 void connman_network_set_data(struct connman_network *network, void *data);
114
115 struct connman_network_driver {
116         const char *name;
117         enum connman_network_type type;
118         int priority;
119         int (*probe) (struct connman_network *network);
120         void (*remove) (struct connman_network *network);
121         int (*connect) (struct connman_network *network);
122         int (*disconnect) (struct connman_network *network);
123 };
124
125 int connman_network_driver_register(struct connman_network_driver *driver);
126 void connman_network_driver_unregister(struct connman_network_driver *driver);
127
128 #ifdef __cplusplus
129 }
130 #endif
131
132 #endif /* __CONNMAN_NETWORK_H */