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