include/network.h

   1
   2 /*
   3  *
   4  *  Connection Manager
   5  *
   6  *  Copyright (C) 2007-2012  Intel Corporation. All rights reserved.
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License version 2 as
  10  *  published by the Free Software Foundation.
  11  *
  12  *  This program is distributed in the hope that it will be useful,
  13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *  GNU General Public License for more details.
  16  *
  17  *  You should have received a copy of the GNU General Public License
  18  *  along with this program; if not, write to the Free Software
  19  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20  *
  21  */
  22
  23 #ifndef __CONNMAN_NETWORK_H
  24 #define __CONNMAN_NETWORK_H
  25
  26 #include <connman/types.h>
  27 #include <connman/device.h>
  28 #include <connman/ipconfig.h>
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 /**
  35  * SECTION:network
  36  * @title: Network premitives
  37  * @short_description: Functions for handling networks
  38  */
  39
  40 enum connman_network_type {
  41         CONNMAN_NETWORK_TYPE_UNKNOWN       = 0,
  42         CONNMAN_NETWORK_TYPE_ETHERNET      = 1,
  43         CONNMAN_NETWORK_TYPE_WIFI          = 2,
  44         CONNMAN_NETWORK_TYPE_WIMAX         = 3,
  45         CONNMAN_NETWORK_TYPE_BLUETOOTH_PAN = 8,
  46         CONNMAN_NETWORK_TYPE_BLUETOOTH_DUN = 9,
  47         CONNMAN_NETWORK_TYPE_CELLULAR      = 10,
  48         CONNMAN_NETWORK_TYPE_VENDOR        = 10000,
  49 };
  50
  51 enum connman_network_error {
  52         CONNMAN_NETWORK_ERROR_UNKNOWN         = 0,
  53         CONNMAN_NETWORK_ERROR_ASSOCIATE_FAIL  = 1,
  54         CONNMAN_NETWORK_ERROR_CONFIGURE_FAIL  = 2,
  55         CONNMAN_NETWORK_ERROR_INVALID_KEY     = 3,
  56         CONNMAN_NETWORK_ERROR_CONNECT_FAIL    = 4,
  57 };
  58
  59 #define CONNMAN_NETWORK_PRIORITY_LOW      -100
  60 #define CONNMAN_NETWORK_PRIORITY_DEFAULT     0
  61 #define CONNMAN_NETWORK_PRIORITY_HIGH      100
  62
  63 struct connman_network;
  64
  65 struct connman_network *connman_network_create(const char *identifier,
  66                                         enum connman_network_type type);
  67
  68 #define connman_network_ref(network) \
  69         connman_network_ref_debug(network, __FILE__, __LINE__, __func__)
  70
  71 #define connman_network_unref(network) \
  72         connman_network_unref_debug(network, __FILE__, __LINE__, __func__)
  73
  74 struct connman_network *
  75 connman_network_ref_debug(struct connman_network *network,
  76                         const char *file, int line, const char *caller);
  77 void connman_network_unref_debug(struct connman_network *network,
  78                         const char *file, int line, const char *caller);
  79
  80 enum connman_network_type connman_network_get_type(struct connman_network *network);
  81 const char *connman_network_get_identifier(struct connman_network *network);
  82
  83 void connman_network_set_index(struct connman_network *network, int index);
  84 int connman_network_get_index(struct connman_network *network);
  85
  86 void connman_network_set_group(struct connman_network *network,
  87                                                 const char *group);
  88 const char *connman_network_get_group(struct connman_network *network);
  89
  90 connman_bool_t connman_network_get_connecting(struct connman_network *network);
  91 int connman_network_set_available(struct connman_network *network,
  92                                                 connman_bool_t available);
  93 connman_bool_t connman_network_get_available(struct connman_network *network);
  94 int connman_network_set_associating(struct connman_network *network,
  95                                                 connman_bool_t associating);
  96 void connman_network_set_error(struct connman_network *network,
  97                                         enum connman_network_error error);
  98 void connman_network_clear_error(struct connman_network *network);
  99 int connman_network_set_connected(struct connman_network *network,
 100                                                 connman_bool_t connected);
 101 connman_bool_t connman_network_get_connected(struct connman_network *network);
 102
 103 connman_bool_t 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                                                 connman_uint8_t strength);
 123 connman_uint8_t connman_network_get_strength(struct connman_network *network);
 124 int connman_network_set_frequency(struct connman_network *network,
 125                                         connman_uint16_t frequency);
 126 connman_uint16_t connman_network_get_frequency(struct connman_network *network);
 127 int connman_network_set_wifi_channel(struct connman_network *network,
 128                                         connman_uint16_t channel);
 129 connman_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, connman_bool_t value);
 137 connman_bool_t 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 */