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
  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         CONNMAN_ELEMENT_TYPE_CONNECTION = 42,
  68         CONNMAN_ELEMENT_TYPE_VENDOR     = 10000,
  69 };
  70
  71 struct connman_driver;
  72
  73 struct connman_element {
  74         gint refcount;
  75         gint index;
  76         gchar *name;
  77         gchar *path;
  78         enum connman_element_type type;
  79         enum connman_element_state state;
  80         enum connman_element_policy policy;
  81         gboolean enabled;
  82         gboolean remember;
  83         guint16 priority;
  84         guint8 strength;
  85         gchar *devpath;
  86         gchar *devname;
  87
  88         struct connman_element *parent;
  89
  90         struct connman_driver *driver;
  91         void *driver_data;
  92
  93         void (*destruct) (struct connman_element *element);
  94
  95         union {
  96                 void *private;
  97                 struct connman_device *device;
  98                 struct connman_network *network;
  99         };
 100
 101         GSList *properties;
 102
 103         struct {
 104                 gchar *address;
 105                 gchar *netmask;
 106                 gchar *gateway;
 107                 gchar *network;
 108                 gchar *broadcast;
 109                 gchar *nameserver;
 110         } ipv4;
 111
 112         struct {
 113                 gchar *security;
 114                 gchar *passphrase;
 115         } wifi;
 116 };
 117
 118 extern struct connman_element *connman_element_create(const char *name);
 119 extern struct connman_element *connman_element_ref(struct connman_element *element);
 120 extern void connman_element_unref(struct connman_element *element);
 121
 122 extern int connman_element_add_static_property(struct connman_element *element,
 123                                 const char *name, int type, const void *value);
 124 extern int connman_element_set_static_property(struct connman_element *element,
 125                                 const char *name, int type, const void *value);
 126 extern int connman_element_add_static_array_property(struct connman_element *element,
 127                         const char *name, int type, const void *value, int len);
 128 extern int connman_element_define_properties(struct connman_element *element, ...);
 129 extern int connman_element_create_property(struct connman_element *element,
 130                                                 const char *name, int type);
 131 extern int connman_element_set_property(struct connman_element *element,
 132                                 enum connman_property_id id, const void *value);
 133 extern int connman_element_get_value(struct connman_element *element,
 134                                 enum connman_property_id id, void *value);
 135 extern gboolean connman_element_get_static_property(struct connman_element *element,
 136                                                 const char *name, void *value);
 137 extern gboolean connman_element_get_static_array_property(struct connman_element *element,
 138                                         const char *name, void *value, int *len);
 139 extern gboolean connman_element_match_static_property(struct connman_element *element,
 140                                         const char *name, const void *value);
 141
 142 extern int connman_element_register(struct connman_element *element,
 143                                         struct connman_element *parent);
 144 extern void connman_element_unregister(struct connman_element *element);
 145 extern void connman_element_unregister_children(struct connman_element *element);
 146 extern void connman_element_update(struct connman_element *element);
 147
 148 extern int connman_element_set_enabled(struct connman_element *element,
 149                                                         gboolean enabled);
 150 extern int connman_element_set_scanning(struct connman_element *element,
 151                                                         gboolean scanning);
 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 */