include/element.h

   1 /*
   2  *
   3  *  Connection Manager
   4  *
   5  *  Copyright (C) 2007-2008  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
  34 /**
  35  * SECTION:element
  36  * @title: Element premitives
  37  * @short_description: Functions for handling elements
  38  */
  39
  40 enum connman_element_state {
  41         CONNMAN_ELEMENT_STATE_UNKNOWN   = 0,
  42         CONNMAN_ELEMENT_STATE_CONNECT   = 1,
  43         CONNMAN_ELEMENT_STATE_CONNECTED = 2,
  44         CONNMAN_ELEMENT_STATE_CLOSED    = 3,
  45 };
  46
  47 enum connman_element_policy {
  48         CONNMAN_ELEMENT_POLICY_UNKNOWN = 0,
  49         CONNMAN_ELEMENT_POLICY_IGNORE  = 1,
  50         CONNMAN_ELEMENT_POLICY_AUTO    = 2,
  51         CONNMAN_ELEMENT_POLICY_ASK     = 3,
  52 };
  53
  54 enum connman_element_type {
  55         CONNMAN_ELEMENT_TYPE_UNKNOWN    = 0,
  56         CONNMAN_ELEMENT_TYPE_ROOT       = 1,
  57         CONNMAN_ELEMENT_TYPE_PROFILE    = 2,
  58         CONNMAN_ELEMENT_TYPE_DEVICE     = 3,
  59         CONNMAN_ELEMENT_TYPE_NETWORK    = 4,
  60         CONNMAN_ELEMENT_TYPE_SERVICE    = 5,
  61         CONNMAN_ELEMENT_TYPE_PPP        = 6,
  62         CONNMAN_ELEMENT_TYPE_IPV4       = 7,
  63         CONNMAN_ELEMENT_TYPE_IPV6       = 8,
  64         CONNMAN_ELEMENT_TYPE_DHCP       = 9,
  65         CONNMAN_ELEMENT_TYPE_BOOTP      = 10,
  66         CONNMAN_ELEMENT_TYPE_ZEROCONF   = 11,
  67
  68         CONNMAN_ELEMENT_TYPE_CONNECTION = 42,
  69 };
  70
  71 enum connman_element_subtype {
  72         CONNMAN_ELEMENT_SUBTYPE_UNKNOWN   = 0,
  73         CONNMAN_ELEMENT_SUBTYPE_FAKE      = 1,
  74         CONNMAN_ELEMENT_SUBTYPE_NETWORK   = 2,
  75         CONNMAN_ELEMENT_SUBTYPE_ETHERNET  = 3,
  76         CONNMAN_ELEMENT_SUBTYPE_WIFI      = 4,
  77         CONNMAN_ELEMENT_SUBTYPE_WIMAX     = 5,
  78         CONNMAN_ELEMENT_SUBTYPE_CELLULAR  = 6,
  79         CONNMAN_ELEMENT_SUBTYPE_BLUETOOTH = 7,
  80 };
  81
  82 struct connman_driver;
  83
  84 struct connman_element {
  85         gint refcount;
  86         gint index;
  87         gchar *name;
  88         gchar *path;
  89         enum connman_element_type type;
  90         enum connman_element_subtype subtype;
  91         enum connman_element_state state;
  92         enum connman_element_policy policy;
  93         gboolean enabled;
  94         gboolean scanning;
  95         gboolean available;
  96         gboolean remember;
  97         guint16 priority;
  98         guint8 strength;
  99         gchar *devpath;
 100         gchar *devname;
 101
 102         struct connman_element *parent;
 103
 104         struct connman_driver *driver;
 105         void *driver_data;
 106
 107         void (*destruct) (struct connman_element *element);
 108
 109         union {
 110                 void *private;
 111                 struct connman_device *device;
 112                 struct connman_network *network;
 113         };
 114
 115         GSList *properties;
 116
 117         struct {
 118                 gchar *address;
 119                 gchar *netmask;
 120                 gchar *gateway;
 121                 gchar *network;
 122                 gchar *broadcast;
 123                 gchar *nameserver;
 124         } ipv4;
 125
 126         struct {
 127                 gchar *security;
 128                 gchar *passphrase;
 129         } wifi;
 130 };
 131
 132 extern struct connman_element *connman_element_create(const char *name);
 133 extern struct connman_element *connman_element_ref(struct connman_element *element);
 134 extern void connman_element_unref(struct connman_element *element);
 135
 136 extern int connman_element_add_static_property(struct connman_element *element,
 137                                 const char *name, int type, const void *value);
 138 extern int connman_element_set_static_property(struct connman_element *element,
 139                                 const char *name, int type, const void *value);
 140 extern int connman_element_add_static_array_property(struct connman_element *element,
 141                         const char *name, int type, const void *value, int len);
 142 extern int connman_element_define_properties(struct connman_element *element, ...);
 143 extern int connman_element_create_property(struct connman_element *element,
 144                                                 const char *name, int type);
 145 extern int connman_element_set_property(struct connman_element *element,
 146                                 enum connman_property_id id, const void *value);
 147 extern int connman_element_get_value(struct connman_element *element,
 148                                 enum connman_property_id id, void *value);
 149 extern gboolean connman_element_get_static_property(struct connman_element *element,
 150                                                 const char *name, void *value);
 151 extern gboolean connman_element_get_static_array_property(struct connman_element *element,
 152                                         const char *name, void *value, int *len);
 153 extern gboolean connman_element_match_static_property(struct connman_element *element,
 154                                         const char *name, const void *value);
 155
 156 extern int connman_element_register(struct connman_element *element,
 157                                         struct connman_element *parent);
 158 extern void connman_element_unregister(struct connman_element *element);
 159 extern void connman_element_unregister_children(struct connman_element *element);
 160 extern void connman_element_update(struct connman_element *element);
 161
 162 extern int connman_element_set_enabled(struct connman_element *element,
 163                                                         gboolean enabled);
 164 extern int connman_element_set_scanning(struct connman_element *element,
 165                                                         gboolean scanning);
 166
 167 static inline void *connman_element_get_data(struct connman_element *element)
 168 {
 169         return element->driver_data;
 170 }
 171
 172 static inline void connman_element_set_data(struct connman_element *element,
 173                                                                 void *data)
 174 {
 175         element->driver_data = data;
 176 }
 177
 178 #ifdef __cplusplus
 179 }
 180 #endif
 181
 182 #endif /* __CONNMAN_ELEMENT_H */