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_state {
  42         CONNMAN_ELEMENT_STATE_UNKNOWN   = 0,
  43         CONNMAN_ELEMENT_STATE_CONNECT   = 1,
  44         CONNMAN_ELEMENT_STATE_CONNECTED = 2,
  45         CONNMAN_ELEMENT_STATE_CLOSED    = 3,
  46 };
  47
  48 enum connman_element_policy {
  49         CONNMAN_ELEMENT_POLICY_UNKNOWN = 0,
  50         CONNMAN_ELEMENT_POLICY_IGNORE  = 1,
  51         CONNMAN_ELEMENT_POLICY_AUTO    = 2,
  52         CONNMAN_ELEMENT_POLICY_ASK     = 3,
  53 };
  54
  55 enum connman_element_type {
  56         CONNMAN_ELEMENT_TYPE_UNKNOWN    = 0,
  57         CONNMAN_ELEMENT_TYPE_ROOT       = 1,
  58         CONNMAN_ELEMENT_TYPE_PROFILE    = 2,
  59         CONNMAN_ELEMENT_TYPE_DEVICE     = 3,
  60         CONNMAN_ELEMENT_TYPE_NETWORK    = 4,
  61         CONNMAN_ELEMENT_TYPE_SERVICE    = 5,
  62         CONNMAN_ELEMENT_TYPE_PPP        = 6,
  63         CONNMAN_ELEMENT_TYPE_IPV4       = 7,
  64         CONNMAN_ELEMENT_TYPE_IPV6       = 8,
  65         CONNMAN_ELEMENT_TYPE_DHCP       = 9,
  66         CONNMAN_ELEMENT_TYPE_BOOTP      = 10,
  67         CONNMAN_ELEMENT_TYPE_ZEROCONF   = 11,
  68         CONNMAN_ELEMENT_TYPE_CONNECTION = 42,
  69         CONNMAN_ELEMENT_TYPE_VENDOR     = 10000,
  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_policy policy;
  82         gboolean enabled;
  83         gboolean remember;
  84         guint16 priority;
  85         guint8 strength;
  86         gchar *devpath;
  87         gchar *devname;
  88
  89         struct connman_element *parent;
  90
  91         struct connman_driver *driver;
  92         void *driver_data;
  93
  94         void (*destruct) (struct connman_element *element);
  95
  96         union {
  97                 void *private;
  98                 struct connman_device *device;
  99                 struct connman_network *network;
 100         };
 101
 102         GSList *properties;
 103
 104         struct {
 105                 enum connman_ipv4_method method;
 106                 gchar *address;
 107                 gchar *netmask;
 108                 gchar *gateway;
 109                 gchar *network;
 110                 gchar *broadcast;
 111                 gchar *nameserver;
 112         } ipv4;
 113
 114         struct {
 115                 gchar *security;
 116                 gchar *passphrase;
 117         } wifi;
 118 };
 119
 120 extern struct connman_element *connman_element_create(const char *name);
 121 extern struct connman_element *connman_element_ref(struct connman_element *element);
 122 extern void connman_element_unref(struct connman_element *element);
 123
 124 extern int connman_element_add_static_property(struct connman_element *element,
 125                                 const char *name, int type, const void *value);
 126 extern int connman_element_set_static_property(struct connman_element *element,
 127                                 const char *name, int type, const void *value);
 128 extern int connman_element_add_static_array_property(struct connman_element *element,
 129                         const char *name, int type, const void *value, int len);
 130 extern int connman_element_define_properties(struct connman_element *element, ...);
 131 extern int connman_element_create_property(struct connman_element *element,
 132                                                 const char *name, int type);
 133 extern int connman_element_set_property(struct connman_element *element,
 134                                 enum connman_property_id id, const void *value);
 135 extern int connman_element_get_value(struct connman_element *element,
 136                                 enum connman_property_id id, void *value);
 137 extern gboolean connman_element_get_static_property(struct connman_element *element,
 138                                                 const char *name, void *value);
 139 extern gboolean connman_element_get_static_array_property(struct connman_element *element,
 140                                         const char *name, void *value, int *len);
 141 extern gboolean connman_element_match_static_property(struct connman_element *element,
 142                                         const char *name, const void *value);
 143
 144 extern int connman_element_register(struct connman_element *element,
 145                                         struct connman_element *parent);
 146 extern void connman_element_unregister(struct connman_element *element);
 147 extern void connman_element_unregister_children(struct connman_element *element);
 148 extern void connman_element_update(struct connman_element *element);
 149
 150 extern int connman_element_set_enabled(struct connman_element *element,
 151                                                         gboolean enabled);
 152 extern int connman_element_set_scanning(struct connman_element *element,
 153                                                         gboolean scanning);
 154
 155 static inline void *connman_element_get_data(struct connman_element *element)
 156 {
 157         return element->driver_data;
 158 }
 159
 160 static inline void connman_element_set_data(struct connman_element *element,
 161                                                                 void *data)
 162 {
 163         element->driver_data = data;
 164 }
 165
 166 #ifdef __cplusplus
 167 }
 168 #endif
 169
 170 #endif /* __CONNMAN_ELEMENT_H */