Add documention for the elements

[framework/connectivity/connman.git] / include / element.h

diff --git a/include/element.h b/include/element.h
index dfcbd0f..e2d7ea8 100644 (file)
--- a/include/element.h
+++ b/include/element.h
@@ -29,6 +29,14 @@ extern "C" {
 #include <errno.h>
 #include <glib.h>
 
+#include <connman/property.h>
+
+/**
+ * SECTION:element
+ * @title: Element premitives
+ * @short_description: Functions for handling elements
+ */
+
 enum connman_element_state {
        CONNMAN_ELEMENT_STATE_UNKNOWN   = 0,
        CONNMAN_ELEMENT_STATE_CONNECT   = 1,
@@ -46,8 +54,9 @@ enum connman_element_type {
        CONNMAN_ELEMENT_TYPE_DHCP       = 6,
        CONNMAN_ELEMENT_TYPE_BOOTP      = 7,
        CONNMAN_ELEMENT_TYPE_ZEROCONF   = 8,
+       CONNMAN_ELEMENT_TYPE_RESOLVER   = 9,
 
-       CONNMAN_ELEMENT_TYPE_CONNECTION = 42,
+       CONNMAN_ELEMENT_TYPE_INTERNET   = 42,
 };
 
 enum connman_element_subtype {
@@ -63,22 +72,21 @@ struct connman_driver;
 
 struct connman_element {
        gint refcount;
+       GStaticMutex mutex;
        gchar *name;
        gchar *path;
        enum connman_element_type type;
        enum connman_element_subtype subtype;
        enum connman_element_state state;
+       gboolean enabled;
+       guint16 priority;
 
        struct connman_element *parent;
 
        struct connman_driver *driver;
        void *driver_data;
 
-       struct {
-               gchar *driver;
-               gchar *vendor;
-               gchar *product;
-       } info;
+       GSList *properties;
 
        struct {
                int index;
@@ -87,6 +95,10 @@ struct connman_element {
        } netdev;
 
        struct {
+               gchar *identifier;
+       } network;
+
+       struct {
                gchar *address;
                gchar *netmask;
                gchar *gateway;
@@ -96,13 +108,24 @@ struct connman_element {
        } ipv4;
 };
 
+#define connman_element_lock(element)    g_static_mutex_lock(&(element)->mutex)
+#define connman_element_unlock(element)  g_static_mutex_unlock(&(element)->mutex)
+
 extern struct connman_element *connman_element_create(void);
 extern struct connman_element *connman_element_ref(struct connman_element *element);
 extern void connman_element_unref(struct connman_element *element);
 
+extern int connman_element_add_static_property(struct connman_element *element,
+                               const char *name, int type, const void *value);
+extern int connman_element_set_property(struct connman_element *element,
+                       enum connman_property_type type, const void *value);
+extern int connman_element_get_value(struct connman_element *element,
+                               enum connman_property_type type, void *value);
+
 extern int connman_element_register(struct connman_element *element,
                                        struct connman_element *parent);
 extern void connman_element_unregister(struct connman_element *element);
+extern void connman_element_unregister_children(struct connman_element *element);
 extern void connman_element_update(struct connman_element *element);
 
 static inline void *connman_element_get_data(struct connman_element *element)