include/network.h

   1 /*
   2  *
   3  *  Connection Manager
   4  *
   5  *  Copyright (C) 2007-2009  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
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 /**
  33  * SECTION:network
  34  * @title: Network premitives
  35  * @short_description: Functions for handling networks
  36  */
  37
  38 enum connman_network_type {
  39         CONNMAN_NETWORK_TYPE_UNKNOWN       = 0,
  40         CONNMAN_NETWORK_TYPE_ETHERNET      = 1,
  41         CONNMAN_NETWORK_TYPE_WIFI          = 2,
  42         CONNMAN_NETWORK_TYPE_WIMAX         = 3,
  43         CONNMAN_NETWORK_TYPE_BLUETOOTH_PAN = 8,
  44         CONNMAN_NETWORK_TYPE_BLUETOOTH_DUN = 9,
  45         CONNMAN_NETWORK_TYPE_CELLULAR      = 10,
  46         CONNMAN_NETWORK_TYPE_MBM           = 22,
  47         CONNMAN_NETWORK_TYPE_HSO           = 23,
  48         CONNMAN_NETWORK_TYPE_VENDOR        = 10000,
  49 };
  50
  51 enum connman_network_protocol {
  52         CONNMAN_NETWORK_PROTOCOL_UNKNOWN = 0,
  53         CONNMAN_NETWORK_PROTOCOL_IP      = 1,
  54         CONNMAN_NETWORK_PROTOCOL_PPP     = 2,
  55 };
  56
  57 enum connman_network_error {
  58         CONNMAN_NETWORK_ERROR_UNKNOWN         = 0,
  59         CONNMAN_NETWORK_ERROR_ASSOCIATE_FAIL  = 1,
  60 };
  61
  62 struct connman_network;
  63
  64 struct connman_network *connman_network_create(const char *identifier,
  65                                         enum connman_network_type type);
  66 struct connman_network *connman_network_ref(struct connman_network *network);
  67 void connman_network_unref(struct connman_network *network);
  68
  69 enum connman_network_type connman_network_get_type(struct connman_network *network);
  70 const char *connman_network_get_identifier(struct connman_network *network);
  71
  72 const char *connman_network_get_path(struct connman_network *network);
  73 void connman_network_set_index(struct connman_network *network, int index);
  74 int connman_network_get_index(struct connman_network *network);
  75
  76 void connman_network_set_protocol(struct connman_network *network,
  77                                         enum connman_network_protocol protocol);
  78 void connman_network_set_group(struct connman_network *network,
  79                                                 const char *group);
  80 const char *connman_network_get_group(struct connman_network *network);
  81
  82 int connman_network_set_available(struct connman_network *network,
  83                                                 connman_bool_t available);
  84 connman_bool_t connman_network_get_available(struct connman_network *network);
  85 int connman_network_set_associating(struct connman_network *network,
  86                                                 connman_bool_t associating);
  87 void connman_network_set_error(struct connman_network *network,
  88                                         enum connman_network_error error);
  89 int connman_network_set_connected(struct connman_network *network,
  90                                                 connman_bool_t connected);
  91 connman_bool_t connman_network_get_connected(struct connman_network *network);
  92
  93 connman_bool_t connman_network_get_associating(struct connman_network *network);
  94
  95 int connman_network_set_address(struct connman_network *network,
  96                                 const void *address, unsigned int size);
  97 int connman_network_set_name(struct connman_network *network,
  98                                                         const char *name);
  99 int connman_network_set_strength(struct connman_network *network,
 100                                                 connman_uint8_t strength);
 101 int connman_network_set_roaming(struct connman_network *network,
 102                                                 connman_bool_t roaming);
 103
 104 int connman_network_set_string(struct connman_network *network,
 105                                         const char *key, const char *value);
 106 const char *connman_network_get_string(struct connman_network *network,
 107                                                         const char *key);
 108 int connman_network_set_bool(struct connman_network *network,
 109                                         const char *key, connman_bool_t value);
 110 connman_bool_t connman_network_get_bool(struct connman_network *network,
 111                                                         const char *key);
 112 int connman_network_set_uint8(struct connman_network *network,
 113                                         const char *key, connman_uint8_t value);
 114 connman_uint8_t connman_network_get_uint8(struct connman_network *network,
 115                                                         const char *key);
 116 int connman_network_set_uint16(struct connman_network *network,
 117                                         const char *key, connman_uint16_t value);
 118 connman_uint16_t connman_network_get_uint16(struct connman_network *network,
 119                                                         const char *key);
 120 int connman_network_set_blob(struct connman_network *network,
 121                         const char *key, const void *data, unsigned int size);
 122 const void *connman_network_get_blob(struct connman_network *network,
 123                                         const char *key, unsigned int *size);
 124
 125 struct connman_device *connman_network_get_device(struct connman_network *network);
 126
 127 void *connman_network_get_data(struct connman_network *network);
 128 void connman_network_set_data(struct connman_network *network, void *data);
 129
 130 struct connman_network_driver {
 131         const char *name;
 132         enum connman_network_type type;
 133         int priority;
 134         int (*probe) (struct connman_network *network);
 135         void (*remove) (struct connman_network *network);
 136         int (*connect) (struct connman_network *network);
 137         int (*disconnect) (struct connman_network *network);
 138 };
 139
 140 int connman_network_driver_register(struct connman_network_driver *driver);
 141 void connman_network_driver_unregister(struct connman_network_driver *driver);
 142
 143 #ifdef __cplusplus
 144 }
 145 #endif
 146
 147 #endif /* __CONNMAN_NETWORK_H */