NMAccessPoint

@@ -39,33 +39,38 @@

Synopsis

#define             NM_ACCESS_POINT_FLAGS
 #define             NM_ACCESS_POINT_WPA_FLAGS
 #define             NM_ACCESS_POINT_RSN_FLAGS
 #define             NM_ACCESS_POINT_SSID
+#define             NM_ACCESS_POINT_BSSID
 #define             NM_ACCESS_POINT_FREQUENCY
-#define             NM_ACCESS_POINT_HW_ADDRESS
 #define             NM_ACCESS_POINT_MODE
 #define             NM_ACCESS_POINT_MAX_BITRATE
 #define             NM_ACCESS_POINT_STRENGTH
+#define             NM_ACCESS_POINT_HW_ADDRESS
                     NMAccessPoint;
                     NMAccessPointClass;
 GObject *           nm_access_point_new                 (DBusGConnection *connection,
                                                          const char *path);
-guint32             nm_access_point_get_flags           (NMAccessPoint *ap);
-guint32             nm_access_point_get_wpa_flags       (NMAccessPoint *ap);
-guint32             nm_access_point_get_rsn_flags       (NMAccessPoint *ap);
-const GByteArray *  nm_access_point_get_ssid            (NMAccessPoint *ap);
+NM80211ApFlags      nm_access_point_get_flags           (NMAccessPoint *ap);
+NM80211ApSecurityFlags  nm_access_point_get_wpa_flags   (NMAccessPoint *ap);
+NM80211ApSecurityFlags  nm_access_point_get_rsn_flags   (NMAccessPoint *ap);
+const GByteArray *      nm_access_point_get_ssid        (NMAccessPoint *ap);
+const char *            nm_access_point_get_bssid       (NMAccessPoint *ap);
 guint32             nm_access_point_get_frequency       (NMAccessPoint *ap);
-const char *        nm_access_point_get_hw_address      (NMAccessPoint *ap);
 NM80211Mode         nm_access_point_get_mode            (NMAccessPoint *ap);
 guint32             nm_access_point_get_max_bitrate     (NMAccessPoint *ap);
 guint8              nm_access_point_get_strength        (NMAccessPoint *ap);
+GSList *                nm_access_point_filter_connections
+                                                        (NMAccessPoint *ap,
+                                                         const GSList *connections);
+const char *            nm_access_point_get_hw_address  (NMAccessPoint *ap);

Object Hierarchy

   GObject
@@ -73,28 +78,29 @@ const char *        
+
 Properties
 +  "bssid"                    gchar*                : Read
   "flags"                    guint                 : Read
   "frequency"                guint                 : Read
   "hw-address"               gchar*                : Read
   "max-bitrate"              guint                 : Read
   "mode"                     guint                 : Read
   "rsn-flags"                guint                 : Read
-  "ssid"                     nm-ssid*              : Read
+  "ssid"                     NMSsid*               : Read
   "strength"                 guchar                : Read
   "wpa-flags"                guint                 : Read
 
 
-
+
 Description
 
 
 
-
+
 Details
-
+
 NM_ACCESS_POINT_FLAGS
 #define NM_ACCESS_POINT_FLAGS       "flags"
 
@@ -102,7 +108,7 @@ const char *        
+
 NM_ACCESS_POINT_WPA_FLAGS
 #define NM_ACCESS_POINT_WPA_FLAGS   "wpa-flags"
 
@@ -110,7 +116,7 @@ const char *        
+
 NM_ACCESS_POINT_RSN_FLAGS
 #define NM_ACCESS_POINT_RSN_FLAGS   "rsn-flags"
 
@@ -118,7 +124,7 @@ const char *        
+
 NM_ACCESS_POINT_SSID
 #define NM_ACCESS_POINT_SSID        "ssid"
 
@@ -126,23 +132,23 @@ const char *        
-NM_ACCESS_POINT_FREQUENCY
-#define NM_ACCESS_POINT_FREQUENCY   "frequency"
+
+NM_ACCESS_POINT_BSSID
+#define NM_ACCESS_POINT_BSSID       "bssid"
 
 
 
 
 
-
-NM_ACCESS_POINT_HW_ADDRESS
-#define NM_ACCESS_POINT_HW_ADDRESS  "hw-address"
+
+NM_ACCESS_POINT_FREQUENCY
+#define NM_ACCESS_POINT_FREQUENCY   "frequency"
 
 
 
 
 
-
+
 NM_ACCESS_POINT_MODE
 #define NM_ACCESS_POINT_MODE        "mode"
 
@@ -150,7 +156,7 @@ const char *        
+
 NM_ACCESS_POINT_MAX_BITRATE
 #define NM_ACCESS_POINT_MAX_BITRATE "max-bitrate"
 
@@ -158,7 +164,7 @@ const char *        
+
 NM_ACCESS_POINT_STRENGTH
 #define NM_ACCESS_POINT_STRENGTH    "strength"
 
@@ -166,14 +172,22 @@ const char *        
+
+NM_ACCESS_POINT_HW_ADDRESS
+#define NM_ACCESS_POINT_HW_ADDRESS  "hw-address"
+
+
+
+
+
+
 NMAccessPoint
 typedef struct _NMAccessPoint NMAccessPoint;
 
 
 
 
-
+
 NMAccessPointClass
 typedef struct {
 	NMObjectClass parent;
@@ -191,7 +205,7 @@ const char *        
+
 nm_access_point_new ()
 GObject *           nm_access_point_new                 (DBusGConnection *connection,
                                                          const char *path);
@@ -208,23 +222,22 @@ Creates a new 
 
 path :
-the DBusobject path of the access point
-
+the DBusobject path of the access point
 
 
 Returns :
- a new access point
+a new access point. [transfer full]
 
 
 
 

 

 
-
+
 nm_access_point_get_flags ()
-guint32             nm_access_point_get_flags           (NMAccessPoint *ap);
+NM80211ApFlags      nm_access_point_get_flags           (NMAccessPoint *ap);
 
-Gets the flags of the access point
+Gets the flags of the access point.
 
 @@ -236,18 +249,17 @@ Gets the flags of the access point
 
-
+
 

 
 Returns :  the flags
- the flags
 
 
 
 
 
-
+
 nm_access_point_get_wpa_flags ()
-guint32             nm_access_point_get_wpa_flags       (NMAccessPoint *ap);
+NM80211ApSecurityFlags  nm_access_point_get_wpa_flags   (NMAccessPoint *ap);
 
-Gets the WPA flags of the access point.
+Gets the WPA (version 1) flags of the access point.
 
 @@ -259,18 +271,18 @@ Gets the WPA flags of the access point.
 
-
+
 

 
 Returns :  the WPA flags
- the WPA flags
 
 
 
 
 
-
+
 nm_access_point_get_rsn_flags ()
-guint32             nm_access_point_get_rsn_flags       (NMAccessPoint *ap);
+NM80211ApSecurityFlags  nm_access_point_get_rsn_flags   (NMAccessPoint *ap);
 
-Gets the RSN flags of the access point.
+Gets the RSN (Robust Secure Network, ie WPA version 2) flags of the access
+point.
 
 @@ -282,16 +294,15 @@ Gets the RSN flags of the access point.
 
-
+
 

 
 Returns :  the RSN flags
- the RSN flags
 
 
 
 
 
-
+
 nm_access_point_get_ssid ()
-const GByteArray *  nm_access_point_get_ssid            (NMAccessPoint *ap);
+const GByteArray *      nm_access_point_get_ssid        (NMAccessPoint *ap);
 
 Gets the SSID of the access point.
 
@@ -305,19 +316,18 @@ Gets the SSID of the access point.
 
 
 Returns :
- the GByteArray containing the SSID. This is the internal copy used by the
-access point, and must not be modified.
-
+the GByteArray containing the SSID. This is the internal copy used by the
+access point, and must not be modified.
 
 
 
 
 
-
-nm_access_point_get_frequency ()
-guint32             nm_access_point_get_frequency       (NMAccessPoint *ap);
+
+nm_access_point_get_bssid ()
+const char *            nm_access_point_get_bssid       (NMAccessPoint *ap);
 
-Gets the frequency of the access point.
+Gets the Basic Service Set ID (BSSID) of the WiFi access point.
 
 @@ -329,18 +339,18 @@ Gets the frequency of the access point.
 
-
+
 

 
 Returns :  the frequency
- the BSSID of the access point. This is an internal string and must
+not be modified or freed.
 
 
 
 
 
-
-nm_access_point_get_hw_address ()
-const char *        nm_access_point_get_hw_address      (NMAccessPoint *ap);
+
+nm_access_point_get_frequency ()
+guint32             nm_access_point_get_frequency       (NMAccessPoint *ap);
 
-Gets the hardware (MAC) address of the access point.
+Gets the frequency of the access point.
 
 @@ -352,15 +362,13 @@ Gets the hardware (MAC) address of the access point.
 
-
+
 

 
 Returns :  the hardware address of the access point. This is the internal string used by the
-access point and must not be modified.
- the frequency
 
 
 
 
 
-
+
 nm_access_point_get_mode ()
 NM80211Mode         nm_access_point_get_mode            (NMAccessPoint *ap);
 
@@ -376,14 +384,13 @@ Gets the mode of the access point.
 
 
 
Returns :
- the mode
-
+the mode
 
 
 
 
 
-
+
 nm_access_point_get_max_bitrate ()
 guint32             nm_access_point_get_max_bitrate     (NMAccessPoint *ap);
 
@@ -399,14 +406,13 @@ Gets the maximum bit rate of the access point.
 
 
 
Returns :
- the maximum bit rate
-
+the maximum bit rate
 
 
 
 
 
-
+
 nm_access_point_get_strength ()
 guint8              nm_access_point_get_strength        (NMAccessPoint *ap);
 
@@ -422,16 +428,86 @@ Gets the current signal strength of the access point.
 
 
 
Returns :
- the signal strength
+the signal strength
+
+
+
+
+
+
+nm_access_point_filter_connections ()
+GSList *                nm_access_point_filter_connections
+                                                        (NMAccessPoint *ap,
+                                                         const GSList *connections);
+
+Filters a given list of connections for a given NMAccessPoint object and
+return connections which may be activated with the access point.  Any
+returned connections will match the ap's SSID and (if given) BSSID and
+other attributes like security settings, channel, etc.
+
+
++
+
+
+
+
+
+
+
+
+
+
+
ap : an NMAccessPoint to filter connections for
connections : a list of NMConnection objects to filter
Returns : a
+list of NMConnection objects that could be activated with the given ap.
+The elements of the list are owned by their creator and should not be freed
+by the caller, but the returned list itself is owned by the caller and should
+be freed with g_slist_free() when it is no longer required. [transfer container][element-type NetworkManager.Connection]
 
 
 
 
 
+
+
+nm_access_point_get_hw_address ()
+const char *            nm_access_point_get_hw_address  (NMAccessPoint *ap);
+
+Warning
+nm_access_point_get_hw_address has been deprecated since version 0.9 and should not be used in newly-written code. Use nm_access_point_get_bssid() instead.
 
-
+
+Gets the hardware (MAC) address of the access point.
+
+
++
+
+
+
+
+
+
+
+
+
+
ap : a NMAccessPoint
+
Returns : the hardware address of the access point. This is the internal string used by the
+access point and must not be modified.
+
+
+
 Property Details
-
+
+The "bssid" property
+  "bssid"                    gchar*                : Read
+
+The BSSID of the access point.
+
+Default value: NULL
+
+
+
 The "flags" property
   "flags"                    guint                 : Read
 
@@ -441,7 +517,7 @@ The flags of the access point.
 
Default value: 0
 
 
-
+
 The "frequency" property
   "frequency"                guint                 : Read
 
@@ -451,7 +527,7 @@ The frequency of the access point.
 
Default value: 0
 
 
-
+
 The "hw-address" property
   "hw-address"               gchar*                : Read
 
@@ -460,7 +536,7 @@ The hardware address of the access point.
 
Default value: NULL
 
 
-
+
 The "max-bitrate" property
   "max-bitrate"              guint                 : Read
 
@@ -469,7 +545,7 @@ The maximum bit rate of the access point.
 
Default value: 0
 
 
-
+
 The "mode" property
   "mode"                     guint                 : Read
 
@@ -479,7 +555,7 @@ The mode of the access point.
 
Default value: 2
 
 
-
+
 The "rsn-flags" property
   "rsn-flags"                guint                 : Read
 
@@ -488,15 +564,15 @@ The RSN flags of the access point.
 
Default value: 0
 
 
-
+
 The "ssid" property
-  "ssid"                     nm-ssid*              : Read
+  "ssid"                     NMSsid*               : Read
 
 The SSID of the access point.
 
 
 
-
+
 The "strength" property
   "strength"                 guchar                : Read
 
@@ -505,7 +581,7 @@ The current signal strength of the access point.
 
Default value: 0
 
 
-
+
 The "wpa-flags" property
   "wpa-flags"                guint                 : Read
 
@@ -517,6 +593,6 @@ The WPA flags of the access point.
 
 
 
-          Generated by GTK-Doc V1.15
+          Generated by GTK-Doc V1.17
 
 
\ No newline at end of file
-- 
cgit 1.3.0-6-gf8a5

`ap` :	an NMAccessPoint to filter connections for
`connections` :	a list of NMConnection objects to filter
Returns :	a +list of NMConnection objects that could be activated with the given `ap`. +The elements of the list are owned by their creator and should not be freed +by the caller, but the returned list itself is owned by the caller and should +be freed with `g_slist_free()` when it is no longer required. [transfer container][element-type NetworkManager.Connection]

`ap` :	a NMAccessPoint +
Returns :	the hardware address of the access point. This is the internal string used by the +access point and must not be modified.