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