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         CONNMAN_NETWORK_ERROR_BLOCKED         = 5,
  59 };
  60
  61 #define CONNMAN_NETWORK_PRIORITY_LOW      -100
  62 #define CONNMAN_NETWORK_PRIORITY_DEFAULT     0
  63 #define CONNMAN_NETWORK_PRIORITY_HIGH      100
  64
  65 struct connman_network;
  66
  67 struct connman_network *connman_network_create(const char *identifier,
  68                                         enum connman_network_type type);
  69
  70 #define connman_network_ref(network) \
  71         connman_network_ref_debug(network, __FILE__, __LINE__, __func__)
  72
  73 #define connman_network_unref(network) \
  74         connman_network_unref_debug(network, __FILE__, __LINE__, __func__)
  75
  76 struct connman_network *
  77 connman_network_ref_debug(struct connman_network *network,
  78                         const char *file, int line, const char *caller);
  79 void connman_network_unref_debug(struct connman_network *network,
  80                         const char *file, int line, const char *caller);
  81
  82 enum connman_network_type connman_network_get_type(struct connman_network *network);
  83 const char *connman_network_get_identifier(struct connman_network *network);
  84
  85 void connman_network_set_index(struct connman_network *network, int index);
  86 int connman_network_get_index(struct connman_network *network);
  87
  88 void connman_network_set_group(struct connman_network *network,
  89                                                 const char *group);
  90 const char *connman_network_get_group(struct connman_network *network);
  91
  92 bool connman_network_get_connecting(struct connman_network *network);
  93 int connman_network_set_available(struct connman_network *network,
  94                                                 bool available);
  95 bool connman_network_get_available(struct connman_network *network);
  96 int connman_network_set_associating(struct connman_network *network,
  97                                                 bool associating);
  98 void connman_network_set_error(struct connman_network *network,
  99                                         enum connman_network_error error);
 100 int connman_network_set_connected(struct connman_network *network,
 101                                                 bool connected);
 102 bool connman_network_get_connected(struct connman_network *network);
 103
 104 bool connman_network_get_associating(struct connman_network *network);
 105
 106 void connman_network_clear_hidden(void *user_data);
 107 int connman_network_connect_hidden(struct connman_network *network,
 108                         char *identity, char* passphrase, void *user_data);
 109
 110 void connman_network_set_ipv4_method(struct connman_network *network,
 111                                         enum connman_ipconfig_method method);
 112 void connman_network_set_ipv6_method(struct connman_network *network,
 113                                         enum connman_ipconfig_method method);
 114 int connman_network_set_ipaddress(struct connman_network *network,
 115                                 struct connman_ipaddress *ipaddress);
 116 int connman_network_set_nameservers(struct connman_network *network,
 117                                 const char *nameservers);
 118 int connman_network_set_domain(struct connman_network *network,
 119                                      const char *domain);
 120 int connman_network_set_name(struct connman_network *network,
 121                                                         const char *name);
 122 int connman_network_set_strength(struct connman_network *network,
 123                                                 uint8_t strength);
 124 uint8_t connman_network_get_strength(struct connman_network *network);
 125 int connman_network_set_frequency(struct connman_network *network,
 126                                         uint16_t frequency);
 127 uint16_t connman_network_get_frequency(struct connman_network *network);
 128 int connman_network_set_wifi_channel(struct connman_network *network,
 129                                         uint16_t channel);
 130 uint16_t connman_network_get_wifi_channel(struct connman_network *network);
 131
 132 int connman_network_set_string(struct connman_network *network,
 133                                         const char *key, const char *value);
 134 const char *connman_network_get_string(struct connman_network *network,
 135                                                         const char *key);
 136 int connman_network_set_bool(struct connman_network *network,
 137                                         const char *key, bool value);
 138 bool connman_network_get_bool(struct connman_network *network,
 139                                                         const char *key);
 140 int connman_network_set_blob(struct connman_network *network,
 141                         const char *key, const void *data, unsigned int size);
 142 const void *connman_network_get_blob(struct connman_network *network,
 143                                         const char *key, unsigned int *size);
 144
 145 struct connman_device *connman_network_get_device(struct connman_network *network);
 146
 147 void *connman_network_get_data(struct connman_network *network);
 148 void connman_network_set_data(struct connman_network *network, void *data);
 149
 150 void connman_network_update(struct connman_network *network);
 151
 152 struct connman_network_driver {
 153         const char *name;
 154         enum connman_network_type type;
 155         int priority;
 156         int (*probe) (struct connman_network *network);
 157         void (*remove) (struct connman_network *network);
 158         int (*connect) (struct connman_network *network);
 159         int (*disconnect) (struct connman_network *network);
 160 };
 161
 162 int connman_network_driver_register(struct connman_network_driver *driver);
 163 void connman_network_driver_unregister(struct connman_network_driver *driver);
 164
 165 #ifdef __cplusplus
 166 }
 167 #endif
 168
 169 #endif /* __CONNMAN_NETWORK_H */