From a4256940da049f91bbbea5e53e469a59ea9c10f7 Mon Sep 17 00:00:00 2001 From: Sjoerd Simons Date: Fri, 25 Oct 2013 21:20:58 +0200 Subject: Imported Upstream version 0.9.8.8 --- docs/libnm-glib/html/NMAccessPoint.html | 377 ++++++++++++++++++-------------- 1 file changed, 208 insertions(+), 169 deletions(-) (limited to 'docs/libnm-glib/html/NMAccessPoint.html') diff --git a/docs/libnm-glib/html/NMAccessPoint.html b/docs/libnm-glib/html/NMAccessPoint.html index a205b980..dfa604c6 100644 --- a/docs/libnm-glib/html/NMAccessPoint.html +++ b/docs/libnm-glib/html/NMAccessPoint.html @@ -3,12 +3,12 @@ NMAccessPoint - + - + @@ -43,34 +43,34 @@

Synopsis

-
                    NMAccessPoint;
-                    NMAccessPointClass;
+
#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_FLAGS
 #define             NM_ACCESS_POINT_FREQUENCY
-#define             NM_ACCESS_POINT_HW_ADDRESS
-#define             NM_ACCESS_POINT_MAX_BITRATE
 #define             NM_ACCESS_POINT_MODE
-#define             NM_ACCESS_POINT_RSN_FLAGS
-#define             NM_ACCESS_POINT_SSID
+#define             NM_ACCESS_POINT_MAX_BITRATE
 #define             NM_ACCESS_POINT_STRENGTH
-#define             NM_ACCESS_POINT_WPA_FLAGS
-gboolean            nm_access_point_connection_valid    (NMAccessPoint *ap,
-                                                         NMConnection *connection);
-GSList *            nm_access_point_filter_connections  (NMAccessPoint *ap,
-                                                         const GSList *connections);
-const char *        nm_access_point_get_bssid           (NMAccessPoint *ap);
+#define             NM_ACCESS_POINT_HW_ADDRESS
+                    NMAccessPoint;
+                    NMAccessPointClass;
+GObject *           nm_access_point_new                 (DBusGConnection *connection,
+                                                         const char *path);
 NM80211ApFlags      nm_access_point_get_flags           (NMAccessPoint *ap);
-guint32             nm_access_point_get_frequency       (NMAccessPoint *ap);
-const char *        nm_access_point_get_hw_address      (NMAccessPoint *ap);
-guint32             nm_access_point_get_max_bitrate     (NMAccessPoint *ap);
-NM80211Mode         nm_access_point_get_mode            (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);
+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);
-NM80211ApSecurityFlags nm_access_point_get_wpa_flags    (NMAccessPoint *ap);
-GObject *           nm_access_point_new                 (DBusGConnection *connection,
-                                                         const char *path);
+GSList *            nm_access_point_filter_connections  (NMAccessPoint *ap,
+                                                         const GSList *connections);
+gboolean            nm_access_point_connection_valid    (NMAccessPoint *ap,
+                                                         NMConnection *connection);
+const char *        nm_access_point_get_hw_address      (NMAccessPoint *ap);
@@ -110,192 +110,177 @@ NMAccessPoint implements

Details

-

NMAccessPoint

-
typedef struct _NMAccessPoint NMAccessPoint;
+

NM_ACCESS_POINT_FLAGS

+
#define NM_ACCESS_POINT_FLAGS       "flags"
+

-

NMAccessPointClass

-
typedef struct {
-	NMObjectClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-} NMAccessPointClass;
+
NM_ACCESS_POINT_WPA_FLAGS

+
#define NM_ACCESS_POINT_WPA_FLAGS   "wpa-flags"
-

NM_ACCESS_POINT_BSSID

-
#define NM_ACCESS_POINT_BSSID       "bssid"
+
NM_ACCESS_POINT_RSN_FLAGS

+
#define NM_ACCESS_POINT_RSN_FLAGS   "rsn-flags"
-

NM_ACCESS_POINT_FLAGS

-
#define NM_ACCESS_POINT_FLAGS       "flags"
+
NM_ACCESS_POINT_SSID

+
#define NM_ACCESS_POINT_SSID        "ssid"
-

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_MAX_BITRATE

-
#define NM_ACCESS_POINT_MAX_BITRATE "max-bitrate"
+
NM_ACCESS_POINT_MODE

+
#define NM_ACCESS_POINT_MODE        "mode"
-

NM_ACCESS_POINT_MODE

-
#define NM_ACCESS_POINT_MODE        "mode"
+
NM_ACCESS_POINT_MAX_BITRATE

+
#define NM_ACCESS_POINT_MAX_BITRATE "max-bitrate"
-

NM_ACCESS_POINT_RSN_FLAGS

-
#define NM_ACCESS_POINT_RSN_FLAGS   "rsn-flags"
+
NM_ACCESS_POINT_STRENGTH

+
#define NM_ACCESS_POINT_STRENGTH    "strength"
-

NM_ACCESS_POINT_SSID

-
#define NM_ACCESS_POINT_SSID        "ssid"
+
NM_ACCESS_POINT_HW_ADDRESS

+
#define NM_ACCESS_POINT_HW_ADDRESS  "hw-address"
-

NM_ACCESS_POINT_STRENGTH

-
#define NM_ACCESS_POINT_STRENGTH    "strength"
-
+

NMAccessPoint

+
typedef struct _NMAccessPoint NMAccessPoint;

-

NM_ACCESS_POINT_WPA_FLAGS

-
#define NM_ACCESS_POINT_WPA_FLAGS   "wpa-flags"
+
NMAccessPointClass

+
typedef struct {
+	NMObjectClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+	void (*_reserved5) (void);
+	void (*_reserved6) (void);
+} NMAccessPointClass;
-

nm_access_point_connection_valid ()

-
gboolean            nm_access_point_connection_valid    (NMAccessPoint *ap,
-                                                         NMConnection *connection);
+

nm_access_point_new ()

+
GObject *           nm_access_point_new                 (DBusGConnection *connection,
+                                                         const char *path);

-Validates a given connection against a given WiFi access point to ensure that -the connection may be activated with that AP. The connection must match the -ap's SSID, (if given) BSSID, and other attributes like security settings, -channel, band, etc. +Creates a new NMAccessPoint.

-
+
+++ - - - - - + + + + - +

ap :

an NMAccessPoint to validate connection against

connection :

an NMConnection to validate against ap +the DBusGConnection

path :

the DBusobject path of the access point

Returns :

 -TRUE if the connection may be activated with this WiFi AP, -FALSE if it cannot be.a new access point. [transfer full] +
-

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. -

+

nm_access_point_get_flags ()

+
NM80211ApFlags      nm_access_point_get_flags           (NMAccessPoint *ap);

-To obtain the list of connections that are compatible with this access point, -use nm_remote_settings_list_connections() and then filter the returned list -for a given NMDevice using nm_device_filter_connections() and finally -filter that list with this function. +Gets the flags of the access point.

-
+
+++ - - - - - - +

ap :

an NMAccessPoint to filter connections for

connections :

a list of -NMConnection objects to filter. [element-type NetworkManager.Connection] +a NMAccessPoint

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] -the flags
-

nm_access_point_get_bssid ()

-
const char *        nm_access_point_get_bssid           (NMAccessPoint *ap);
+

nm_access_point_get_wpa_flags ()

+
NM80211ApSecurityFlags nm_access_point_get_wpa_flags    (NMAccessPoint *ap);

-Gets the Basic Service Set ID (BSSID) of the WiFi access point. +Gets the WPA (version 1) flags of the access point.

-
+
+++ @@ -304,21 +289,24 @@ Gets the Basic Service Set ID (BSSID) of the WiFi access point. - +

ap :

Returns :

the BSSID of the access point. This is an internal string and must -not be modified or freed.the WPA flags
-

nm_access_point_get_flags ()

-
NM80211ApFlags      nm_access_point_get_flags           (NMAccessPoint *ap);
+

nm_access_point_get_rsn_flags ()

+
NM80211ApSecurityFlags nm_access_point_get_rsn_flags    (NMAccessPoint *ap);

-Gets the flags of the access point. +Gets the RSN (Robust Secure Network, ie WPA version 2) flags of the access +point.

-
+
+++ @@ -327,20 +315,23 @@ Gets the flags of the access point. - +

ap :

Returns :

the flagsthe RSN flags
-

nm_access_point_get_frequency ()

-
guint32             nm_access_point_get_frequency       (NMAccessPoint *ap);
+

nm_access_point_get_ssid ()

+
const GByteArray *  nm_access_point_get_ssid            (NMAccessPoint *ap);

-Gets the frequency of the access point. +Gets the SSID of the access point.

-
+
+++ @@ -349,24 +340,24 @@ Gets the frequency of the access point. - +

ap :

Returns :

the frequencythe GByteArray containing the SSID. This is the internal copy used by the +access point, and must not be modified.
-

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.

-
+

nm_access_point_get_bssid ()

+
const char *        nm_access_point_get_bssid           (NMAccessPoint *ap);

-Gets the hardware (MAC) address of the access point. +Gets the Basic Service Set ID (BSSID) of the WiFi access point.

-
+
+++ @@ -375,21 +366,24 @@ Gets the hardware (MAC) address of the access point. - +

ap :

Returns :

the hardware address of the access point. This is the internal string used by the -access point and must not be modified.the BSSID of the access point. This is an internal string and must +not be modified or freed.
-

nm_access_point_get_max_bitrate ()

-
guint32             nm_access_point_get_max_bitrate     (NMAccessPoint *ap);
+

nm_access_point_get_frequency ()

+
guint32             nm_access_point_get_frequency       (NMAccessPoint *ap);

-Gets the maximum bit rate of the access point. +Gets the frequency of the access point.

-
+
+++ @@ -398,7 +392,7 @@ Gets the maximum bit rate of the access point. - +

ap :

Returns :

the maximum bit ratethe frequency
@@ -410,8 +404,11 @@ Gets the maximum bit rate of the access point.

Gets the mode of the access point.

-
+
+++ @@ -427,14 +424,16 @@ Gets the mode of the access point.
-

nm_access_point_get_rsn_flags ()

-
NM80211ApSecurityFlags nm_access_point_get_rsn_flags    (NMAccessPoint *ap);
+

nm_access_point_get_max_bitrate ()

+
guint32             nm_access_point_get_max_bitrate     (NMAccessPoint *ap);

-Gets the RSN (Robust Secure Network, ie WPA version 2) flags of the access -point. +Gets the maximum bit rate of the access point.

-

ap :
+
+++ @@ -443,20 +442,23 @@ point. - +

ap :

Returns :

the RSN flagsthe maximum bit rate
-

nm_access_point_get_ssid ()

-
const GByteArray *  nm_access_point_get_ssid            (NMAccessPoint *ap);
+

nm_access_point_get_strength ()

+
guint8              nm_access_point_get_strength        (NMAccessPoint *ap);

-Gets the SSID of the access point. +Gets the current signal strength of the access point.

-
+
+++ @@ -465,80 +467,117 @@ Gets the SSID of the access point. - +

ap :

Returns :

the GByteArray containing the SSID. This is the internal copy used by the -access point, and must not be modified.the signal strength
-

nm_access_point_get_strength ()

-
guint8              nm_access_point_get_strength        (NMAccessPoint *ap);
+

nm_access_point_filter_connections ()

+
GSList *            nm_access_point_filter_connections  (NMAccessPoint *ap,
+                                                         const GSList *connections);

-Gets the current signal strength of the access point. +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.

-
+

+To obtain the list of connections that are compatible with this access point, +use nm_remote_settings_list_connections() and then filter the returned list +for a given NMDevice using nm_device_filter_connections() and finally +filter that list with this function. +

+
+++ - + + + + - +

ap :

a NMAccessPoint +an NMAccessPoint to filter connections for

connections :

a list of +NMConnection objects to filter. [element-type NetworkManager.Connection]

Returns :

the signal strengtha +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_wpa_flags ()

-
NM80211ApSecurityFlags nm_access_point_get_wpa_flags    (NMAccessPoint *ap);
+

nm_access_point_connection_valid ()

+
gboolean            nm_access_point_connection_valid    (NMAccessPoint *ap,
+                                                         NMConnection *connection);

-Gets the WPA (version 1) flags of the access point. +Validates a given connection against a given WiFi access point to ensure that +the connection may be activated with that AP. The connection must match the +ap's SSID, (if given) BSSID, and other attributes like security settings, +channel, band, etc.

-
+
+++ - + + + + - +

ap :

a NMAccessPoint +an NMAccessPoint to validate connection against

connection :

an NMConnection to validate against ap

Returns :

the WPA flags +TRUE if the connection may be activated with this WiFi AP, +FALSE if it cannot be.
-

nm_access_point_new ()

-
GObject *           nm_access_point_new                 (DBusGConnection *connection,
-                                                         const char *path);
+

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.

+

-Creates a new NMAccessPoint. +Gets the hardware (MAC) address of the access point.

-
+
+++ - - + - - - - - +

connection :

the DBusGConnection +

ap :

a NMAccessPoint

path :

the DBusobject path of the access point

Returns :

a new access point. [transfer full] -the hardware address of the access point. This is the internal string used by the +access point and must not be modified.
@@ -643,6 +682,6 @@ The WPA flags of the access point.
- Generated by GTK-Doc V1.18
+ Generated by GTK-Doc V1.19
\ No newline at end of file -- cgit 1.3.0-6-gf8a5