include/network.h

   1 /*
   2  *
   3  *  Connection Manager
   4  *
   5  *  Copyright (C) 2007-2013  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 <stdbool.h>
  26 #include <stdint.h>
  27
  28 #include <dbus/dbus.h>
  29
  30 #include <connman/device.h>
  31 #include <connman/ipconfig.h>
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 /**
  38  * SECTION:network
  39  * @title: Network premitives
  40  * @short_description: Functions for handling networks
  41  */
  42
  43 enum connman_network_type {
  44         CONNMAN_NETWORK_TYPE_UNKNOWN       = 0,
  45         CONNMAN_NETWORK_TYPE_ETHERNET      = 1,
  46         CONNMAN_NETWORK_TYPE_WIFI          = 2,
  47         CONNMAN_NETWORK_TYPE_BLUETOOTH_PAN = 8,
  48         CONNMAN_NETWORK_TYPE_BLUETOOTH_DUN = 9,
  49         CONNMAN_NETWORK_TYPE_CELLULAR      = 10,
  50         CONNMAN_NETWORK_TYPE_GADGET        = 11,
  51         CONNMAN_NETWORK_TYPE_VENDOR        = 10000,
  52 };
  53
  54 enum connman_network_error {
  55         CONNMAN_NETWORK_ERROR_UNKNOWN         = 0,
  56         CONNMAN_NETWORK_ERROR_ASSOCIATE_FAIL  = 1,
  57         CONNMAN_NETWORK_ERROR_CONFIGURE_FAIL  = 2,
  58         CONNMAN_NETWORK_ERROR_INVALID_KEY     = 3,
  59         CONNMAN_NETWORK_ERROR_CONNECT_FAIL    = 4,
  60         CONNMAN_NETWORK_ERROR_BLOCKED         = 5,
  61 };
  62
  63 #define CONNMAN_NETWORK_PRIORITY_LOW      -100
  64 #define CONNMAN_NETWORK_PRIORITY_DEFAULT     0
  65 #define CONNMAN_NETWORK_PRIORITY_HIGH      100
  66
  67 struct connman_network;
  68
  69 struct connman_network *connman_network_create(const char *identifier,
  70                                         enum connman_network_type type);
  71
  72 #define connman_network_ref(network) \
  73         connman_network_ref_debug(network, __FILE__, __LINE__, __func__)
  74
  75 #define connman_network_unref(network) \
  76         connman_network_unref_debug(network, __FILE__, __LINE__, __func__)
  77
  78 struct connman_network *
  79 connman_network_ref_debug(struct connman_network *network,
  80                         const char *file, int line, const char *caller);
  81 void connman_network_unref_debug(struct connman_network *network,
  82                         const char *file, int line, const char *caller);
  83
  84 enum connman_network_type connman_network_get_type(struct connman_network *network);
  85 const char *connman_network_get_identifier(struct connman_network *network);
  86
  87 void connman_network_set_index(struct connman_network *network, int index);
  88 int connman_network_get_index(struct connman_network *network);
  89
  90 void connman_network_set_group(struct connman_network *network,
  91                                                 const char *group);
  92 const char *connman_network_get_group(struct connman_network *network);
  93
  94 bool connman_network_get_connecting(struct connman_network *network);
  95 int connman_network_set_available(struct connman_network *network,
  96                                                 bool available);
  97 bool connman_network_get_available(struct connman_network *network);
  98 int connman_network_set_associating(struct connman_network *network,
  99                                                 bool associating);
 100 void connman_network_set_error(struct connman_network *network,
 101                                         enum connman_network_error error);
 102 int connman_network_set_connected(struct connman_network *network,
 103                                                 bool connected);
 104 bool connman_network_get_connected(struct connman_network *network);
 105 void connman_network_set_connected_dhcp_later(struct connman_network *network,
 106                 uint32_t sec);
 107
 108 bool connman_network_get_associating(struct connman_network *network);
 109
 110 void connman_network_clear_hidden(void *user_data);
 111 int connman_network_connect_hidden(struct connman_network *network,
 112                         char *identity, char* passphrase, void *user_data);
 113
 114 void connman_network_set_ipv4_method(struct connman_network *network,
 115                                         enum connman_ipconfig_method method);
 116 void connman_network_set_ipv6_method(struct connman_network *network,
 117                                         enum connman_ipconfig_method method);
 118 int connman_network_set_ipaddress(struct connman_network *network,
 119                                 struct connman_ipaddress *ipaddress);
 120 int connman_network_set_nameservers(struct connman_network *network,
 121                                 const char *nameservers);
 122 int connman_network_set_domain(struct connman_network *network,
 123                                      const char *domain);
 124 int connman_network_set_name(struct connman_network *network,
 125                                                         const char *name);
 126 int connman_network_set_strength(struct connman_network *network,
 127                                                 uint8_t strength);
 128 uint8_t connman_network_get_strength(struct connman_network *network);
 129 int connman_network_set_frequency(struct connman_network *network,
 130                                         uint16_t frequency);
 131 uint16_t connman_network_get_frequency(struct connman_network *network);
 132 int connman_network_set_wifi_channel(struct connman_network *network,
 133                                         uint16_t channel);
 134 uint16_t connman_network_get_wifi_channel(struct connman_network *network);
 135
 136 int connman_network_set_string(struct connman_network *network,
 137                                         const char *key, const char *value);
 138 const char *connman_network_get_string(struct connman_network *network,
 139                                                         const char *key);
 140 int connman_network_set_bool(struct connman_network *network,
 141                                         const char *key, bool value);
 142 bool connman_network_get_bool(struct connman_network *network,
 143                                                         const char *key);
 144 int connman_network_set_blob(struct connman_network *network,
 145                         const char *key, const void *data, unsigned int size);
 146 const void *connman_network_get_blob(struct connman_network *network,
 147                                         const char *key, unsigned int *size);
 148
 149 struct connman_device *connman_network_get_device(struct connman_network *network);
 150
 151 void *connman_network_get_data(struct connman_network *network);
 152 void connman_network_set_data(struct connman_network *network, void *data);
 153
 154 void connman_network_update(struct connman_network *network);
 155
 156 struct connman_network_driver {
 157         const char *name;
 158         enum connman_network_type type;
 159         int priority;
 160         int (*probe) (struct connman_network *network);
 161         void (*remove) (struct connman_network *network);
 162         int (*connect) (struct connman_network *network);
 163         int (*disconnect) (struct connman_network *network);
 164 };
 165
 166 int connman_network_driver_register(struct connman_network_driver *driver);
 167 void connman_network_driver_unregister(struct connman_network_driver *driver);
 168
 169 void connman_network_append_acddbus(DBusMessageIter *dict,
 170                 struct connman_network *network);
 171
 172 #ifdef __cplusplus
 173 }
 174 #endif
 175
 176 #endif /* __CONNMAN_NETWORK_H */