include/network.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_NETWORK_H
  23 #define __CONNMAN_NETWORK_H
  24
  25 #include <connman/types.h>
  26 #include <connman/device.h>
  27 #include <connman/ipconfig.h>
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 /**
  34  * SECTION:network
  35  * @title: Network premitives
  36  * @short_description: Functions for handling networks
  37  */
  38
  39 enum connman_network_type {
  40         CONNMAN_NETWORK_TYPE_UNKNOWN       = 0,
  41         CONNMAN_NETWORK_TYPE_ETHERNET      = 1,
  42         CONNMAN_NETWORK_TYPE_WIFI          = 2,
  43         CONNMAN_NETWORK_TYPE_WIMAX         = 3,
  44         CONNMAN_NETWORK_TYPE_BLUETOOTH_PAN = 8,
  45         CONNMAN_NETWORK_TYPE_BLUETOOTH_DUN = 9,
  46         CONNMAN_NETWORK_TYPE_CELLULAR      = 10,
  47         CONNMAN_NETWORK_TYPE_VENDOR        = 10000,
  48 };
  49
  50 enum connman_network_error {
  51         CONNMAN_NETWORK_ERROR_UNKNOWN         = 0,
  52         CONNMAN_NETWORK_ERROR_ASSOCIATE_FAIL  = 1,
  53         CONNMAN_NETWORK_ERROR_CONFIGURE_FAIL  = 2,
  54         CONNMAN_NETWORK_ERROR_INVALID_KEY     = 3,
  55         CONNMAN_NETWORK_ERROR_CONNECT_FAIL    = 4,
  56 };
  57
  58 #define CONNMAN_NETWORK_PRIORITY_LOW      -100
  59 #define CONNMAN_NETWORK_PRIORITY_DEFAULT     0
  60 #define CONNMAN_NETWORK_PRIORITY_HIGH      100
  61
  62 struct connman_network;
  63
  64 struct connman_network *connman_network_create(const char *identifier,
  65                                         enum connman_network_type type);
  66 struct connman_network *connman_network_ref(struct connman_network *network);
  67 void connman_network_unref(struct connman_network *network);
  68
  69 enum connman_network_type connman_network_get_type(struct connman_network *network);
  70 const char *connman_network_get_identifier(struct connman_network *network);
  71
  72 struct connman_element *connman_network_get_element(
  73                                 struct connman_network *network);
  74 void connman_network_set_index(struct connman_network *network, int index);
  75 int connman_network_get_index(struct connman_network *network);
  76
  77 void connman_network_set_group(struct connman_network *network,
  78                                                 const char *group);
  79 const char *connman_network_get_group(struct connman_network *network);
  80
  81 connman_bool_t connman_network_get_connecting(struct connman_network *network);
  82 int connman_network_set_available(struct connman_network *network,
  83                                                 connman_bool_t available);
  84 connman_bool_t connman_network_get_available(struct connman_network *network);
  85 int connman_network_set_associating(struct connman_network *network,
  86                                                 connman_bool_t associating);
  87 void connman_network_set_error(struct connman_network *network,
  88                                         enum connman_network_error error);
  89 void connman_network_clear_error(struct connman_network *network);
  90 int connman_network_set_connected(struct connman_network *network,
  91                                                 connman_bool_t connected);
  92 connman_bool_t connman_network_get_connected(struct connman_network *network);
  93
  94 connman_bool_t connman_network_get_associating(struct connman_network *network);
  95
  96 void connman_network_set_ipv4_method(struct connman_network *network,
  97                                         enum connman_ipconfig_method method);
  98 void connman_network_set_ipv6_method(struct connman_network *network,
  99                                         enum connman_ipconfig_method method);
 100 int connman_network_set_ipaddress(struct connman_network *network,
 101                                 struct connman_ipaddress *ipaddress);
 102 int connman_network_set_nameservers(struct connman_network *network,
 103                                 const char *nameservers);
 104 int connman_network_set_domain(struct connman_network *network,
 105                                      const char *domain);
 106 int connman_network_set_pac(struct connman_network *network,
 107                                 const char *pac);
 108 int connman_network_set_name(struct connman_network *network,
 109                                                         const char *name);
 110 int connman_network_set_strength(struct connman_network *network,
 111                                                 connman_uint8_t strength);
 112 int connman_network_set_roaming(struct connman_network *network,
 113                                                 connman_bool_t roaming);
 114
 115 int connman_network_set_string(struct connman_network *network,
 116                                         const char *key, const char *value);
 117 const char *connman_network_get_string(struct connman_network *network,
 118                                                         const char *key);
 119 int connman_network_set_bool(struct connman_network *network,
 120                                         const char *key, connman_bool_t value);
 121 connman_bool_t connman_network_get_bool(struct connman_network *network,
 122                                                         const char *key);
 123 int connman_network_set_uint8(struct connman_network *network,
 124                                         const char *key, connman_uint8_t value);
 125 connman_uint8_t connman_network_get_uint8(struct connman_network *network,
 126                                                         const char *key);
 127 int connman_network_set_uint16(struct connman_network *network,
 128                                         const char *key, connman_uint16_t value);
 129 connman_uint16_t connman_network_get_uint16(struct connman_network *network,
 130                                                         const char *key);
 131 int connman_network_set_blob(struct connman_network *network,
 132                         const char *key, const void *data, unsigned int size);
 133 const void *connman_network_get_blob(struct connman_network *network,
 134                                         const char *key, unsigned int *size);
 135
 136 struct connman_device *connman_network_get_device(struct connman_network *network);
 137
 138 void *connman_network_get_data(struct connman_network *network);
 139 void connman_network_set_data(struct connman_network *network, void *data);
 140
 141 void connman_network_update(struct connman_network *network);
 142
 143 struct connman_network_driver {
 144         const char *name;
 145         enum connman_network_type type;
 146         int priority;
 147         int (*probe) (struct connman_network *network);
 148         void (*remove) (struct connman_network *network);
 149         int (*connect) (struct connman_network *network);
 150         int (*disconnect) (struct connman_network *network);
 151 };
 152
 153 int connman_network_driver_register(struct connman_network_driver *driver);
 154 void connman_network_driver_unregister(struct connman_network_driver *driver);
 155
 156 #ifdef __cplusplus
 157 }
 158 #endif
 159
 160 #endif /* __CONNMAN_NETWORK_H */