include/element.h

   1 /*
   2  *
   3  *  Connection Manager
   4  *
   5  *  Copyright (C) 2007-2010  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 #include <connman/types.h>
  34 #include <connman/ipconfig.h>
  35
  36 /**
  37  * SECTION:element
  38  * @title: Element premitives
  39  * @short_description: Functions for handling elements
  40  */
  41
  42 enum connman_element_type {
  43         CONNMAN_ELEMENT_TYPE_UNKNOWN    = 0,
  44         CONNMAN_ELEMENT_TYPE_ROOT       = 1,
  45         CONNMAN_ELEMENT_TYPE_PROFILE    = 2,
  46         CONNMAN_ELEMENT_TYPE_DEVICE     = 3,
  47         CONNMAN_ELEMENT_TYPE_NETWORK    = 4,
  48         CONNMAN_ELEMENT_TYPE_SERVICE    = 5,
  49         CONNMAN_ELEMENT_TYPE_IPV6       = 8,
  50         CONNMAN_ELEMENT_TYPE_BOOTP      = 10,
  51         CONNMAN_ELEMENT_TYPE_ZEROCONF   = 11,
  52         CONNMAN_ELEMENT_TYPE_VENDOR     = 10000,
  53 };
  54
  55 enum connman_element_state {
  56         CONNMAN_ELEMENT_STATE_UNKNOWN = 0,
  57         CONNMAN_ELEMENT_STATE_ERROR   = 1,
  58         CONNMAN_ELEMENT_STATE_IDLE    = 2,
  59         CONNMAN_ELEMENT_STATE_DONE    = 3,
  60 };
  61
  62 enum connman_element_error {
  63         CONNMAN_ELEMENT_ERROR_UNKNOWN        = 0,
  64         CONNMAN_ELEMENT_ERROR_FAILED         = 1,
  65         CONNMAN_ELEMENT_ERROR_DHCP_FAILED    = 2,
  66         CONNMAN_ELEMENT_ERROR_CONNECT_FAILED = 3,
  67 };
  68
  69 struct connman_driver;
  70
  71 struct connman_element {
  72         gint refcount;
  73         gint index;
  74         gchar *name;
  75         gchar *path;
  76         enum connman_element_type type;
  77         enum connman_element_state state;
  78         enum connman_element_error error;
  79         gboolean enabled;
  80         gchar *devname;
  81
  82         GHashTable *children;
  83         struct connman_element *parent;
  84
  85         struct connman_driver *driver;
  86         void *driver_data;
  87
  88         void (*destruct) (struct connman_element *element);
  89
  90         union {
  91                 void *private;
  92                 struct connman_device *device;
  93                 struct connman_network *network;
  94         };
  95
  96         GHashTable *properties;
  97
  98         gchar *hostname;
  99         gchar *domainname;
 100
 101         struct {
 102                 enum connman_ipconfig_method method;
 103                 gchar *address;
 104                 gchar *peer;
 105                 gchar *netmask;
 106                 gchar *gateway;
 107                 gchar *network;
 108                 gchar *broadcast;
 109                 gchar *nameserver;
 110                 gchar *timeserver;
 111                 gchar *pac;
 112         } ipv4;
 113
 114         struct {
 115                 enum connman_ipconfig_method method;
 116                 gchar *address;
 117                 int prefix_len;
 118                 gchar *gateway;
 119                 gchar *network;
 120         } ipv6;
 121 };
 122
 123 struct connman_element *connman_element_create(const char *name);
 124 struct connman_element *connman_element_ref(struct connman_element *element);
 125 void connman_element_unref(struct connman_element *element);
 126
 127 int connman_element_get_value(struct connman_element *element,
 128                                 enum connman_property_id id, void *value);
 129
 130 int connman_element_set_string(struct connman_element *element,
 131                                         const char *key, const char *value);
 132 const char *connman_element_get_string(struct connman_element *element,
 133                                                         const char *key);
 134 int connman_element_set_bool(struct connman_element *element,
 135                                 const char *key, connman_bool_t value);
 136 connman_bool_t connman_element_get_bool(struct connman_element *element,
 137                                                         const char *key);
 138 int connman_element_set_uint8(struct connman_element *element,
 139                                 const char *key, connman_uint8_t value);
 140 connman_uint8_t connman_element_get_uint8(struct connman_element *element,
 141                                                         const char *key);
 142 int connman_element_set_blob(struct connman_element *element,
 143                         const char *key, const void *data, unsigned int size);
 144 const void *connman_element_get_blob(struct connman_element *element,
 145                                         const char *key, unsigned int *size);
 146
 147 int connman_element_register(struct connman_element *element,
 148                                         struct connman_element *parent);
 149 void connman_element_unregister(struct connman_element *element);
 150 void connman_element_unregister_children(struct connman_element *element);
 151 void connman_element_unregister_children_type(struct connman_element *element,
 152                                                 enum connman_element_type type);
 153 void connman_element_update(struct connman_element *element);
 154
 155 int connman_element_set_enabled(struct connman_element *element,
 156                                                         gboolean enabled);
 157 void connman_element_set_error(struct connman_element *element,
 158                                         enum connman_element_error error);
 159
 160 static inline void *connman_element_get_data(struct connman_element *element)
 161 {
 162         return element->driver_data;
 163 }
 164
 165 static inline void connman_element_set_data(struct connman_element *element,
 166                                                                 void *data)
 167 {
 168         element->driver_data = data;
 169 }
 170
 171 #ifdef __cplusplus
 172 }
 173 #endif
 174
 175 #endif /* __CONNMAN_ELEMENT_H */