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