libnm/nm-device-wifi.h

   1 /* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
   2 /*
   3  * This library is free software; you can redistribute it and/or
   4  * modify it under the terms of the GNU Lesser General Public
   5  * License as published by the Free Software Foundation; either
   6  * version 2 of the License, or (at your option) any later version.
   7  *
   8  * This library is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * Lesser General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public
  14  * License along with this library; if not, write to the
  15  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  16  * Boston, MA 02110-1301 USA.
  17  *
  18  * Copyright 2007 - 2008 Novell, Inc.
  19  * Copyright 2007 - 2012 Red Hat, Inc.
  20  */
  21
  22 #ifndef __NM_DEVICE_WIFI_H__
  23 #define __NM_DEVICE_WIFI_H__
  24
  25 #if !defined (__NETWORKMANAGER_H_INSIDE__) && !defined (NETWORKMANAGER_COMPILATION)
  26 #error "Only <NetworkManager.h> can be included directly."
  27 #endif
  28
  29 #include <nm-device.h>
  30
  31 G_BEGIN_DECLS
  32
  33 #define NM_TYPE_DEVICE_WIFI            (nm_device_wifi_get_type ())
  34 #define NM_DEVICE_WIFI(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), NM_TYPE_DEVICE_WIFI, NMDeviceWifi))
  35 #define NM_DEVICE_WIFI_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), NM_TYPE_DEVICE_WIFI, NMDeviceWifiClass))
  36 #define NM_IS_DEVICE_WIFI(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_DEVICE_WIFI))
  37 #define NM_IS_DEVICE_WIFI_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_DEVICE_WIFI))
  38 #define NM_DEVICE_WIFI_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), NM_TYPE_DEVICE_WIFI, NMDeviceWifiClass))
  39
  40 #define NM_DEVICE_WIFI_HW_ADDRESS          "hw-address"
  41 #define NM_DEVICE_WIFI_PERMANENT_HW_ADDRESS "perm-hw-address"
  42 #define NM_DEVICE_WIFI_MODE                "mode"
  43 #define NM_DEVICE_WIFI_BITRATE             "bitrate"
  44 #define NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT "active-access-point"
  45 #define NM_DEVICE_WIFI_CAPABILITIES        "wireless-capabilities"
  46 #define NM_DEVICE_WIFI_ACCESS_POINTS       "access-points"
  47
  48 struct _NMDeviceWifi {
  49         NMDevice parent;
  50 };
  51
  52 typedef struct {
  53         NMDeviceClass parent;
  54
  55         /* Signals */
  56         void (*access_point_added) (NMDeviceWifi *device, NMAccessPoint *ap);
  57         void (*access_point_removed) (NMDeviceWifi *device, NMAccessPoint *ap);
  58
  59         /*< private >*/
  60         gpointer padding[4];
  61 } NMDeviceWifiClass;
  62
  63 GType nm_device_wifi_get_type (void);
  64
  65 const char *             nm_device_wifi_get_hw_address           (NMDeviceWifi *device);
  66 const char *             nm_device_wifi_get_permanent_hw_address (NMDeviceWifi *device);
  67 NM80211Mode              nm_device_wifi_get_mode                 (NMDeviceWifi *device);
  68 guint32                  nm_device_wifi_get_bitrate              (NMDeviceWifi *device);
  69 NMDeviceWifiCapabilities nm_device_wifi_get_capabilities         (NMDeviceWifi *device);
  70 NMAccessPoint *          nm_device_wifi_get_active_access_point  (NMDeviceWifi *device);
  71
  72 NMAccessPoint *          nm_device_wifi_get_access_point_by_path (NMDeviceWifi *device,
  73                                                                   const char *path);
  74
  75 const GPtrArray *        nm_device_wifi_get_access_points        (NMDeviceWifi *device);
  76
  77 gboolean                 nm_device_wifi_request_scan             (NMDeviceWifi *device,
  78                                                                   GCancellable *cancellable,
  79                                                                   GError **error);
  80 NM_AVAILABLE_IN_1_2
  81 gboolean                 nm_device_wifi_request_scan_options     (NMDeviceWifi *device,
  82                                                                   GVariant *options,
  83                                                                   GCancellable *cancellable,
  84                                                                   GError **error);
  85 void                     nm_device_wifi_request_scan_async       (NMDeviceWifi *device,
  86                                                                   GCancellable *cancellable,
  87                                                                   GAsyncReadyCallback callback,
  88                                                                   gpointer user_data);
  89 NM_AVAILABLE_IN_1_2
  90 void                     nm_device_wifi_request_scan_options_async (NMDeviceWifi *device,
  91                                                                     GVariant *options,
  92                                                                     GCancellable *cancellable,
  93                                                                     GAsyncReadyCallback callback,
  94                                                                     gpointer user_data);
  95 gboolean                 nm_device_wifi_request_scan_finish      (NMDeviceWifi *device,
  96                                                                   GAsyncResult *result,
  97                                                                   GError **error);
  98
  99 G_END_DECLS
 100
 101 #endif /* __NM_DEVICE_WIFI_H__ */