Add more property helpers
[connman] / include / element.h
1 /*
2  *
3  *  Connection Manager
4  *
5  *  Copyright (C) 2007-2008  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_ELEMENT_H
23 #define __CONNMAN_ELEMENT_H
24
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28
29 #include <errno.h>
30 #include <glib.h>
31
32 #include <connman/property.h>
33
34 /**
35  * SECTION:element
36  * @title: Element premitives
37  * @short_description: Functions for handling elements
38  */
39
40 enum connman_element_state {
41         CONNMAN_ELEMENT_STATE_UNKNOWN   = 0,
42         CONNMAN_ELEMENT_STATE_CONNECT   = 1,
43         CONNMAN_ELEMENT_STATE_CONNECTED = 2,
44         CONNMAN_ELEMENT_STATE_CLOSED    = 3,
45 };
46
47 enum connman_element_type {
48         CONNMAN_ELEMENT_TYPE_UNKNOWN    = 0,
49         CONNMAN_ELEMENT_TYPE_ROOT       = 1,
50         CONNMAN_ELEMENT_TYPE_PROFILE    = 2,
51         CONNMAN_ELEMENT_TYPE_DEVICE     = 3,
52         CONNMAN_ELEMENT_TYPE_NETWORK    = 4,
53         CONNMAN_ELEMENT_TYPE_IPV4       = 5,
54         CONNMAN_ELEMENT_TYPE_IPV6       = 6,
55         CONNMAN_ELEMENT_TYPE_DHCP       = 7,
56         CONNMAN_ELEMENT_TYPE_BOOTP      = 8,
57         CONNMAN_ELEMENT_TYPE_ZEROCONF   = 9,
58         CONNMAN_ELEMENT_TYPE_RESOLVER   = 10,
59
60         CONNMAN_ELEMENT_TYPE_INTERNET   = 42,
61 };
62
63 enum connman_element_subtype {
64         CONNMAN_ELEMENT_SUBTYPE_UNKNOWN   = 0,
65         CONNMAN_ELEMENT_SUBTYPE_FAKE      = 1,
66         CONNMAN_ELEMENT_SUBTYPE_NETWORK   = 2,
67         CONNMAN_ELEMENT_SUBTYPE_ETHERNET  = 3,
68         CONNMAN_ELEMENT_SUBTYPE_WIFI      = 4,
69         CONNMAN_ELEMENT_SUBTYPE_WIMAX     = 5,
70         CONNMAN_ELEMENT_SUBTYPE_MODEM     = 6,
71         CONNMAN_ELEMENT_SUBTYPE_BLUETOOTH = 7,
72 };
73
74 struct connman_driver;
75
76 struct connman_element {
77         gint refcount;
78         GStaticMutex mutex;
79         gint index;
80         gchar *name;
81         gchar *path;
82         enum connman_element_type type;
83         enum connman_element_subtype subtype;
84         enum connman_element_state state;
85         gboolean enabled;
86         guint16 priority;
87
88         struct connman_element *parent;
89
90         struct connman_driver *driver;
91         void *driver_data;
92
93         GSList *properties;
94
95         struct {
96                 gchar *identifier;
97         } network;
98
99         struct {
100                 gchar *address;
101                 gchar *netmask;
102                 gchar *gateway;
103                 gchar *network;
104                 gchar *broadcast;
105                 gchar *nameserver;
106         } ipv4;
107 };
108
109 #define connman_element_lock(element)    g_static_mutex_lock(&(element)->mutex)
110 #define connman_element_unlock(element)  g_static_mutex_unlock(&(element)->mutex)
111
112 extern struct connman_element *connman_element_create(const char *name);
113 extern struct connman_element *connman_element_ref(struct connman_element *element);
114 extern void connman_element_unref(struct connman_element *element);
115
116 extern int connman_element_add_static_property(struct connman_element *element,
117                                 const char *name, int type, const void *value);
118 extern int connman_element_add_static_array_property(struct connman_element *element,
119                         const char *name, int type, const void *value, int len);
120 extern int connman_element_define_properties(struct connman_element *element, ...);
121 extern int connman_element_create_property(struct connman_element *element,
122                                                 const char *name, int type);
123 extern int connman_element_set_property(struct connman_element *element,
124                                 enum connman_property_id id, const void *value);
125 extern int connman_element_get_value(struct connman_element *element,
126                                 enum connman_property_id id, void *value);
127 extern gboolean connman_element_get_static_property(struct connman_element *element,
128                                                 const char *name, void *value);
129 extern gboolean connman_element_get_static_array_property(struct connman_element *element,
130                                         const char *name, void *value, int *len);
131 extern gboolean connman_element_match_static_property(struct connman_element *element,
132                                         const char *name, const void *value);
133
134 extern int connman_element_register(struct connman_element *element,
135                                         struct connman_element *parent);
136 extern void connman_element_unregister(struct connman_element *element);
137 extern void connman_element_unregister_children(struct connman_element *element);
138 extern void connman_element_update(struct connman_element *element);
139
140 extern int connman_element_set_enabled(struct connman_element *element,
141                                                         gboolean enabled);
142
143 extern int connman_element_set_enabled(struct connman_element *element,
144                                                         gboolean enabled);
145
146 static inline void *connman_element_get_data(struct connman_element *element)
147 {
148         return element->driver_data;
149 }
150
151 static inline void connman_element_set_data(struct connman_element *element,
152                                                                 void *data)
153 {
154         element->driver_data = data;
155 }
156
157 #ifdef __cplusplus
158 }
159 #endif
160
161 #endif /* __CONNMAN_ELEMENT_H */