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