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 };
  55
  56 #define CONNMAN_NETWORK_PRIORITY_LOW      -100
  57 #define CONNMAN_NETWORK_PRIORITY_DEFAULT     0
  58 #define CONNMAN_NETWORK_PRIORITY_HIGH      100
  59
  60 struct connman_network;
  61
  62 struct connman_network *connman_network_create(const char *identifier,
  63                                         enum connman_network_type type);
  64 struct connman_network *connman_network_ref(struct connman_network *network);
  65 void connman_network_unref(struct connman_network *network);
  66
  67 enum connman_network_type connman_network_get_type(struct connman_network *network);
  68 const char *connman_network_get_identifier(struct connman_network *network);
  69
  70 struct connman_element *connman_network_get_element(
  71                                 struct connman_network *network);
  72 void connman_network_set_index(struct connman_network *network, int index);
  73 int connman_network_get_index(struct connman_network *network);
  74
  75 void connman_network_set_group(struct connman_network *network,
  76                                                 const char *group);
  77 const char *connman_network_get_group(struct connman_network *network);
  78
  79 int connman_network_set_available(struct connman_network *network,
  80                                                 connman_bool_t available);
  81 connman_bool_t connman_network_get_available(struct connman_network *network);
  82 int connman_network_set_associating(struct connman_network *network,
  83                                                 connman_bool_t associating);
  84 void connman_network_set_error(struct connman_network *network,
  85                                         enum connman_network_error error);
  86 int connman_network_set_connected(struct connman_network *network,
  87                                                 connman_bool_t connected);
  88 connman_bool_t connman_network_get_connected(struct connman_network *network);
  89
  90 connman_bool_t connman_network_get_associating(struct connman_network *network);
  91
  92 void connman_network_set_ipv4_method(struct connman_network *network,
  93                                         enum connman_ipconfig_method method);
  94 void connman_network_set_ipv6_method(struct connman_network *network,
  95                                         enum connman_ipconfig_method method);
  96
  97 int connman_network_set_address(struct connman_network *network,
  98                                 const void *address, unsigned int size);
  99 int connman_network_set_name(struct connman_network *network,
 100                                                         const char *name);
 101 int connman_network_set_strength(struct connman_network *network,
 102                                                 connman_uint8_t strength);
 103 int connman_network_set_roaming(struct connman_network *network,
 104                                                 connman_bool_t roaming);
 105
 106 int connman_network_set_string(struct connman_network *network,
 107                                         const char *key, const char *value);
 108 const char *connman_network_get_string(struct connman_network *network,
 109                                                         const char *key);
 110 int connman_network_set_passphrase(struct connman_network *network,
 111                                         const char* passphrase);
 112 int connman_network_set_bool(struct connman_network *network,
 113                                         const char *key, connman_bool_t value);
 114 connman_bool_t connman_network_get_bool(struct connman_network *network,
 115                                                         const char *key);
 116 int connman_network_set_uint8(struct connman_network *network,
 117                                         const char *key, connman_uint8_t value);
 118 connman_uint8_t connman_network_get_uint8(struct connman_network *network,
 119                                                         const char *key);
 120 int connman_network_set_uint16(struct connman_network *network,
 121                                         const char *key, connman_uint16_t value);
 122 connman_uint16_t connman_network_get_uint16(struct connman_network *network,
 123                                                         const char *key);
 124 int connman_network_set_blob(struct connman_network *network,
 125                         const char *key, const void *data, unsigned int size);
 126 const void *connman_network_get_blob(struct connman_network *network,
 127                                         const char *key, unsigned int *size);
 128
 129 struct connman_device *connman_network_get_device(struct connman_network *network);
 130
 131 void *connman_network_get_data(struct connman_network *network);
 132 void connman_network_set_data(struct connman_network *network, void *data);
 133
 134 void connman_network_update(struct connman_network *network);
 135
 136 struct connman_network_driver {
 137         const char *name;
 138         enum connman_network_type type;
 139         int priority;
 140         int (*probe) (struct connman_network *network);
 141         void (*remove) (struct connman_network *network);
 142         int (*connect) (struct connman_network *network);
 143         int (*disconnect) (struct connman_network *network);
 144         int (*setup) (struct connman_network *network, const char *key);
 145 };
 146
 147 int connman_network_driver_register(struct connman_network_driver *driver);
 148 void connman_network_driver_unregister(struct connman_network_driver *driver);
 149
 150 #ifdef __cplusplus
 151 }
 152 #endif
 153
 154 #endif /* __CONNMAN_NETWORK_H */