include/element.h

   1 /*
   2  *
   3  *  Connection Manager
   4  *
   5  *  Copyright (C) 2007-2009  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/ipv4.h>
  34
  35 /**
  36  * SECTION:element
  37  * @title: Element premitives
  38  * @short_description: Functions for handling elements
  39  */
  40
  41 enum connman_element_type {
  42         CONNMAN_ELEMENT_TYPE_UNKNOWN    = 0,
  43         CONNMAN_ELEMENT_TYPE_ROOT       = 1,
  44         CONNMAN_ELEMENT_TYPE_PROFILE    = 2,
  45         CONNMAN_ELEMENT_TYPE_DEVICE     = 3,
  46         CONNMAN_ELEMENT_TYPE_NETWORK    = 4,
  47         CONNMAN_ELEMENT_TYPE_SERVICE    = 5,
  48         CONNMAN_ELEMENT_TYPE_PPP        = 6,
  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 struct connman_driver;
  59
  60 struct connman_element {
  61         gint refcount;
  62         gint index;
  63         gchar *name;
  64         gchar *path;
  65         enum connman_element_type type;
  66         gboolean enabled;
  67         guint16 priority;
  68         guint8 strength;
  69         gchar *devpath;
  70         gchar *devname;
  71
  72         struct connman_element *parent;
  73
  74         struct connman_driver *driver;
  75         void *driver_data;
  76
  77         void (*destruct) (struct connman_element *element);
  78
  79         union {
  80                 void *private;
  81                 struct connman_device *device;
  82                 struct connman_network *network;
  83         };
  84
  85         GSList *properties;
  86
  87         struct {
  88                 enum connman_ipv4_method method;
  89                 gchar *address;
  90                 gchar *netmask;
  91                 gchar *gateway;
  92                 gchar *network;
  93                 gchar *broadcast;
  94                 gchar *nameserver;
  95         } ipv4;
  96
  97         struct {
  98                 gchar *security;
  99                 gchar *passphrase;
 100         } wifi;
 101 };
 102
 103 extern struct connman_element *connman_element_create(const char *name);
 104 extern struct connman_element *connman_element_ref(struct connman_element *element);
 105 extern void connman_element_unref(struct connman_element *element);
 106
 107 extern int connman_element_add_static_property(struct connman_element *element,
 108                                 const char *name, int type, const void *value);
 109 extern int connman_element_set_static_property(struct connman_element *element,
 110                                 const char *name, int type, const void *value);
 111 extern int connman_element_add_static_array_property(struct connman_element *element,
 112                         const char *name, int type, const void *value, int len);
 113 extern int connman_element_define_properties(struct connman_element *element, ...);
 114 extern int connman_element_create_property(struct connman_element *element,
 115                                                 const char *name, int type);
 116 extern int connman_element_set_property(struct connman_element *element,
 117                                 enum connman_property_id id, const void *value);
 118 extern int connman_element_get_value(struct connman_element *element,
 119                                 enum connman_property_id id, void *value);
 120 extern gboolean connman_element_get_static_property(struct connman_element *element,
 121                                                 const char *name, void *value);
 122 extern gboolean connman_element_get_static_array_property(struct connman_element *element,
 123                                         const char *name, void *value, int *len);
 124 extern gboolean connman_element_match_static_property(struct connman_element *element,
 125                                         const char *name, const void *value);
 126
 127 extern int connman_element_register(struct connman_element *element,
 128                                         struct connman_element *parent);
 129 extern void connman_element_unregister(struct connman_element *element);
 130 extern void connman_element_unregister_children(struct connman_element *element);
 131 extern void connman_element_update(struct connman_element *element);
 132
 133 extern int connman_element_set_enabled(struct connman_element *element,
 134                                                         gboolean enabled);
 135 extern int connman_element_set_scanning(struct connman_element *element,
 136                                                         gboolean scanning);
 137
 138 static inline void *connman_element_get_data(struct connman_element *element)
 139 {
 140         return element->driver_data;
 141 }
 142
 143 static inline void connman_element_set_data(struct connman_element *element,
 144                                                                 void *data)
 145 {
 146         element->driver_data = data;
 147 }
 148
 149 #ifdef __cplusplus
 150 }
 151 #endif
 152
 153 #endif /* __CONNMAN_ELEMENT_H */