libnm/nm-access-point.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 - 2011 Red Hat, Inc.
  20  */
  21
  22 #ifndef __NM_ACCESS_POINT_H__
  23 #define __NM_ACCESS_POINT_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-object.h>
  30
  31 G_BEGIN_DECLS
  32
  33 #define NM_TYPE_ACCESS_POINT            (nm_access_point_get_type ())
  34 #define NM_ACCESS_POINT(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), NM_TYPE_ACCESS_POINT, NMAccessPoint))
  35 #define NM_ACCESS_POINT_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), NM_TYPE_ACCESS_POINT, NMAccessPointClass))
  36 #define NM_IS_ACCESS_POINT(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_ACCESS_POINT))
  37 #define NM_IS_ACCESS_POINT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_ACCESS_POINT))
  38 #define NM_ACCESS_POINT_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), NM_TYPE_ACCESS_POINT, NMAccessPointClass))
  39
  40 #define NM_ACCESS_POINT_FLAGS       "flags"
  41 #define NM_ACCESS_POINT_WPA_FLAGS   "wpa-flags"
  42 #define NM_ACCESS_POINT_RSN_FLAGS   "rsn-flags"
  43 #define NM_ACCESS_POINT_SSID        "ssid"
  44 #define NM_ACCESS_POINT_BSSID       "bssid"
  45 #define NM_ACCESS_POINT_FREQUENCY   "frequency"
  46 #define NM_ACCESS_POINT_MODE        "mode"
  47 #define NM_ACCESS_POINT_MAX_BITRATE "max-bitrate"
  48 #define NM_ACCESS_POINT_STRENGTH    "strength"
  49 #define NM_ACCESS_POINT_LAST_SEEN   "last-seen"
  50
  51 /* DEPRECATED */
  52 #define NM_ACCESS_POINT_HW_ADDRESS  "hw-address"
  53
  54
  55 struct _NMAccessPoint {
  56         NMObject parent;
  57 };
  58
  59 typedef struct {
  60         NMObjectClass parent;
  61
  62         /*< private >*/
  63         gpointer padding[4];
  64 } NMAccessPointClass;
  65
  66 GType nm_access_point_get_type (void);
  67
  68 NM80211ApFlags         nm_access_point_get_flags        (NMAccessPoint *ap);
  69 NM80211ApSecurityFlags nm_access_point_get_wpa_flags    (NMAccessPoint *ap);
  70 NM80211ApSecurityFlags nm_access_point_get_rsn_flags    (NMAccessPoint *ap);
  71 GBytes *               nm_access_point_get_ssid         (NMAccessPoint *ap);
  72 const char *           nm_access_point_get_bssid        (NMAccessPoint *ap);
  73 guint32                nm_access_point_get_frequency    (NMAccessPoint *ap);
  74 NM80211Mode            nm_access_point_get_mode         (NMAccessPoint *ap);
  75 guint32                nm_access_point_get_max_bitrate  (NMAccessPoint *ap);
  76 guint8                 nm_access_point_get_strength     (NMAccessPoint *ap);
  77 NM_AVAILABLE_IN_1_2
  78 gint                   nm_access_point_get_last_seen    (NMAccessPoint *ap);
  79
  80 GPtrArray *            nm_access_point_filter_connections (NMAccessPoint *ap,
  81                                                            const GPtrArray *connections);
  82
  83 gboolean               nm_access_point_connection_valid   (NMAccessPoint *ap,
  84                                                            NMConnection *connection);
  85
  86 G_END_DECLS
  87
  88 #endif /* __NM_ACCESS_POINT_H__ */