From b436a68a20ff3114ded32a7a3d70cdd4954039f9 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Sat, 12 Nov 2011 01:36:14 +0100 Subject: Imported Upstream version 0.9.2.0 --- docs/libnm-util/html/NMSettingWireless.html | 452 +++++++++++++--------------- 1 file changed, 213 insertions(+), 239 deletions(-) (limited to 'docs/libnm-util/html/NMSettingWireless.html') diff --git a/docs/libnm-util/html/NMSettingWireless.html b/docs/libnm-util/html/NMSettingWireless.html index c719a248..a860f226 100644 --- a/docs/libnm-util/html/NMSettingWireless.html +++ b/docs/libnm-util/html/NMSettingWireless.html @@ -8,7 +8,7 @@ - + @@ -44,70 +44,67 @@
 #include <nm-setting-wireless.h>
 
-#define             NM_SETTING_WIRELESS_SETTING_NAME
-enum                NMSettingWirelessError;
-#define             NM_TYPE_SETTING_WIRELESS_ERROR
-#define             NM_SETTING_WIRELESS_ERROR
-GQuark              nm_setting_wireless_error_quark     (void);
-#define             NM_SETTING_WIRELESS_SSID
-#define             NM_SETTING_WIRELESS_MODE
+                    NMSettingWireless;
+                    NMSettingWirelessClass;
+enum                NMSettingWirelessError;
 #define             NM_SETTING_WIRELESS_BAND
-#define             NM_SETTING_WIRELESS_CHANNEL
 #define             NM_SETTING_WIRELESS_BSSID
-#define             NM_SETTING_WIRELESS_RATE
-#define             NM_SETTING_WIRELESS_TX_POWER
-#define             NM_SETTING_WIRELESS_MAC_ADDRESS
+#define             NM_SETTING_WIRELESS_CHANNEL
 #define             NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS
+#define             NM_SETTING_WIRELESS_MAC_ADDRESS
 #define             NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST
-#define             NM_SETTING_WIRELESS_MTU
-#define             NM_SETTING_WIRELESS_SEEN_BSSIDS
-#define             NM_SETTING_WIRELESS_SEC
+#define             NM_SETTING_WIRELESS_MODE
 #define             NM_SETTING_WIRELESS_MODE_ADHOC
 #define             NM_SETTING_WIRELESS_MODE_INFRA
-                    NMSettingWireless;
-                    NMSettingWirelessClass;
-GType               nm_setting_wireless_get_type        (void);
-NMSetting *         nm_setting_wireless_new             (void);
-const GByteArray *  nm_setting_wireless_get_ssid        (NMSettingWireless *setting);
-const char *        nm_setting_wireless_get_mode        (NMSettingWireless *setting);
+#define             NM_SETTING_WIRELESS_MTU
+#define             NM_SETTING_WIRELESS_RATE
+#define             NM_SETTING_WIRELESS_SEC
+#define             NM_SETTING_WIRELESS_SEEN_BSSIDS
+#define             NM_SETTING_WIRELESS_SETTING_NAME
+#define             NM_SETTING_WIRELESS_SSID
+#define             NM_SETTING_WIRELESS_TX_POWER
+gboolean            nm_setting_wireless_add_seen_bssid  (NMSettingWireless *setting,
+                                                         const char *bssid);
+gboolean            nm_setting_wireless_ap_security_compatible
+                                                        (NMSettingWireless *s_wireless,
+                                                         NMSettingWirelessSecurity *s_wireless_sec,
+                                                         NM80211ApFlags ap_flags,
+                                                         NM80211ApSecurityFlags ap_wpa,
+                                                         NM80211ApSecurityFlags ap_rsn,
+                                                         NM80211Mode ap_mode);
+GQuark              nm_setting_wireless_error_quark     (void);
 const char *        nm_setting_wireless_get_band        (NMSettingWireless *setting);
-guint32             nm_setting_wireless_get_channel     (NMSettingWireless *setting);
 const GByteArray *  nm_setting_wireless_get_bssid       (NMSettingWireless *setting);
-guint32             nm_setting_wireless_get_rate        (NMSettingWireless *setting);
-guint32             nm_setting_wireless_get_tx_power    (NMSettingWireless *setting);
-const GByteArray *  nm_setting_wireless_get_mac_address (NMSettingWireless *setting);
+guint32             nm_setting_wireless_get_channel     (NMSettingWireless *setting);
 const GByteArray *  nm_setting_wireless_get_cloned_mac_address
                                                         (NMSettingWireless *setting);
+const GByteArray *  nm_setting_wireless_get_mac_address (NMSettingWireless *setting);
 const GSList *      nm_setting_wireless_get_mac_address_blacklist
                                                         (NMSettingWireless *setting);
+const char *        nm_setting_wireless_get_mode        (NMSettingWireless *setting);
 guint32             nm_setting_wireless_get_mtu         (NMSettingWireless *setting);
-const char *        nm_setting_wireless_get_security    (NMSettingWireless *setting);
-gboolean            nm_setting_wireless_add_seen_bssid  (NMSettingWireless *setting,
-                                                         const char *bssid);
 guint32             nm_setting_wireless_get_num_seen_bssids
                                                         (NMSettingWireless *setting);
+guint32             nm_setting_wireless_get_rate        (NMSettingWireless *setting);
+const char *        nm_setting_wireless_get_security    (NMSettingWireless *setting);
 const char *        nm_setting_wireless_get_seen_bssid  (NMSettingWireless *setting,
                                                          guint32 i);
-gboolean            nm_setting_wireless_ap_security_compatible
-                                                        (NMSettingWireless *s_wireless,
-                                                         NMSettingWirelessSecurity *s_wireless_sec,
-                                                         NM80211ApFlags ap_flags,
-                                                         NM80211ApSecurityFlags ap_wpa,
-                                                         NM80211ApSecurityFlags ap_rsn,
-                                                         NM80211Mode ap_mode);
+const GByteArray *  nm_setting_wireless_get_ssid        (NMSettingWireless *setting);
+guint32             nm_setting_wireless_get_tx_power    (NMSettingWireless *setting);
+NMSetting *         nm_setting_wireless_new             (void);
 

Object Hierarchy

-
-  GEnum
-   +----NMSettingWirelessError
-
   GObject
    +----NMSetting
          +----NMSettingWireless
 
+
+  GEnum
+   +----NMSettingWirelessError
+

Properties

@@ -137,15 +134,30 @@ necessary for connection to 802.11 WiFi networks.

Details

-

NM_SETTING_WIRELESS_SETTING_NAME

-
#define NM_SETTING_WIRELESS_SETTING_NAME "802-11-wireless"
+

NMSettingWireless

+
typedef struct _NMSettingWireless NMSettingWireless;
+

+

+
+
+
+

NMSettingWirelessClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingWirelessClass;
 


-

enum NMSettingWirelessError

+

enum NMSettingWirelessError

typedef enum {
 	NM_SETTING_WIRELESS_ERROR_UNKNOWN = 0,
 	NM_SETTING_WIRELESS_ERROR_INVALID_PROPERTY,
@@ -190,55 +202,16 @@ set to a value that requires the 
-

NM_TYPE_SETTING_WIRELESS_ERROR

-
#define NM_TYPE_SETTING_WIRELESS_ERROR (nm_setting_wireless_error_get_type ()) 
-
-

-

-
-
-
-

NM_SETTING_WIRELESS_ERROR

-
#define NM_SETTING_WIRELESS_ERROR nm_setting_wireless_error_quark ()
-
-

-

-
-
-
-

nm_setting_wireless_error_quark ()

-
GQuark              nm_setting_wireless_error_quark     (void);
-

-Registers an error quark for NMSettingWireless if necessary. -

-
-- - - - -

Returns :

the error quark used for NMSettingWireless errors.
-
-
-
-

NM_SETTING_WIRELESS_SSID

-
#define NM_SETTING_WIRELESS_SSID        "ssid"
-
-

-

-
-
-
-

NM_SETTING_WIRELESS_MODE

-
#define NM_SETTING_WIRELESS_MODE        "mode"
+

NM_SETTING_WIRELESS_BAND

+
#define NM_SETTING_WIRELESS_BAND        "band"
 


-

NM_SETTING_WIRELESS_BAND

-
#define NM_SETTING_WIRELESS_BAND        "band"
+

NM_SETTING_WIRELESS_BSSID

+
#define NM_SETTING_WIRELESS_BSSID       "bssid"
 

@@ -253,50 +226,53 @@ Registers an error quark for
-

NM_SETTING_WIRELESS_BSSID

-
#define NM_SETTING_WIRELESS_BSSID       "bssid"
+

NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS

+
#define NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS "cloned-mac-address"
 


-

NM_SETTING_WIRELESS_RATE

-
#define NM_SETTING_WIRELESS_RATE        "rate"
+

NM_SETTING_WIRELESS_MAC_ADDRESS

+
#define NM_SETTING_WIRELESS_MAC_ADDRESS "mac-address"
 


-

NM_SETTING_WIRELESS_TX_POWER

-
#define NM_SETTING_WIRELESS_TX_POWER    "tx-power"
+

NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST

+
#define NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST "mac-address-blacklist"
 


-

NM_SETTING_WIRELESS_MAC_ADDRESS

-
#define NM_SETTING_WIRELESS_MAC_ADDRESS "mac-address"
+

NM_SETTING_WIRELESS_MODE

+
#define NM_SETTING_WIRELESS_MODE        "mode"
 


-

NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS

-
#define NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS "cloned-mac-address"
+

NM_SETTING_WIRELESS_MODE_ADHOC

+
#define NM_SETTING_WIRELESS_MODE_ADHOC  "adhoc"
 

+Indicates Ad-Hoc mode where no access point is expected to be present.


-

NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST

-
#define NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST "mac-address-blacklist"
+

NM_SETTING_WIRELESS_MODE_INFRA

+
#define NM_SETTING_WIRELESS_MODE_INFRA  "infrastructure"
 

+Indicates infrastructure mode where an access point is expected to be present +for this connection.


@@ -309,8 +285,8 @@ Registers an error quark for
-

NM_SETTING_WIRELESS_SEEN_BSSIDS

-
#define NM_SETTING_WIRELESS_SEEN_BSSIDS "seen-bssids"
+

NM_SETTING_WIRELESS_RATE

+
#define NM_SETTING_WIRELESS_RATE        "rate"
 

@@ -325,75 +301,48 @@ Registers an error quark for
-

NM_SETTING_WIRELESS_MODE_ADHOC

-
#define NM_SETTING_WIRELESS_MODE_ADHOC  "adhoc"
+

NM_SETTING_WIRELESS_SEEN_BSSIDS

+
#define NM_SETTING_WIRELESS_SEEN_BSSIDS "seen-bssids"
 

-Indicates Ad-Hoc mode where no access point is expected to be present.


-

NM_SETTING_WIRELESS_MODE_INFRA

-
#define NM_SETTING_WIRELESS_MODE_INFRA  "infrastructure"
+

NM_SETTING_WIRELESS_SETTING_NAME

+
#define NM_SETTING_WIRELESS_SETTING_NAME "802-11-wireless"
 

-Indicates infrastructure mode where an access point is expected to be present -for this connection.


-

NMSettingWireless

-
typedef struct _NMSettingWireless NMSettingWireless;
-

-

-
-
-
-

NMSettingWirelessClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingWirelessClass;
+

NM_SETTING_WIRELESS_SSID

+
#define NM_SETTING_WIRELESS_SSID        "ssid"
 


-

nm_setting_wireless_get_type ()

-
GType               nm_setting_wireless_get_type        (void);
+

NM_SETTING_WIRELESS_TX_POWER

+
#define NM_SETTING_WIRELESS_TX_POWER    "tx-power"
+


-

nm_setting_wireless_new ()

-
NMSetting *         nm_setting_wireless_new             (void);
+

nm_setting_wireless_add_seen_bssid ()

+
gboolean            nm_setting_wireless_add_seen_bssid  (NMSettingWireless *setting,
+                                                         const char *bssid);

-Creates a new NMSettingWireless object with default values. +Adds a new WiFi AP's BSSID to the previously seen BSSID list of the setting. +NetworkManager tracks previously seen BSSIDs internally so this function +no longer has much use.

- - - - -

Returns :

the new empty NMSettingWireless object. [transfer full] -
-
-
-
-

nm_setting_wireless_get_ssid ()

-
const GByteArray *  nm_setting_wireless_get_ssid        (NMSettingWireless *setting);
-
- @@ -401,54 +350,94 @@ Creates a new bssid :

+
+ + - +

setting :

the new BSSID to add to the list

Returns :

the "ssid" property of the setting +TRUE if bssid was already known, FALSE if not

-

nm_setting_wireless_get_mode ()

-
const char *        nm_setting_wireless_get_mode        (NMSettingWireless *setting);
+

nm_setting_wireless_ap_security_compatible ()

+
gboolean            nm_setting_wireless_ap_security_compatible
+                                                        (NMSettingWireless *s_wireless,
+                                                         NMSettingWirelessSecurity *s_wireless_sec,
+                                                         NM80211ApFlags ap_flags,
+                                                         NM80211ApSecurityFlags ap_wpa,
+                                                         NM80211ApSecurityFlags ap_rsn,
+                                                         NM80211Mode ap_mode);
+

+Given a NMSettingWireless and an optional NMSettingWirelessSecurity, +determine if the configuration given by the settings is compatible with +the security of an access point using that access point's capability flags +and mode. Useful for clients that wish to filter a set of connections +against a set of access points and determine which connections are +compatible with which access points. +

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

setting :

the NMSettingWireless +

s_wireless :

a NMSettingWireless

s_wireless_sec :

a NMSettingWirelessSecurity or NULL +

ap_flags :

the NM80211ApFlags of the given access point

ap_wpa :

the NM80211ApSecurityFlags of the given access point's WPA +capabilities

ap_rsn :

the NM80211ApSecurityFlags of the given access point's WPA2/RSN +capabilities

ap_mode :

the 802.11 mode of the AP, either Ad-Hoc or Infrastructure

Returns :

the "mode" property of the setting +TRUE if the given settings are compatible with the access point's +security flags and mode, FALSE if they are not.

-

nm_setting_wireless_get_band ()

-
const char *        nm_setting_wireless_get_band        (NMSettingWireless *setting);
+

nm_setting_wireless_error_quark ()

+
GQuark              nm_setting_wireless_error_quark     (void);
+

+Registers an error quark for NMSettingWireless if necessary. +

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

setting :

the NMSettingWireless -

Returns :

the "band" property of the setting
the error quark used for NMSettingWireless errors.

-

nm_setting_wireless_get_channel ()

-
guint32             nm_setting_wireless_get_channel     (NMSettingWireless *setting);
+

nm_setting_wireless_get_band ()

+
const char *        nm_setting_wireless_get_band        (NMSettingWireless *setting);
@@ -459,7 +448,7 @@ Creates a new Returns :

-
+
the "channel" property of the settingthe "band" property of the setting
@@ -485,8 +474,8 @@ Creates a new -

nm_setting_wireless_get_rate ()

-
guint32             nm_setting_wireless_get_rate        (NMSettingWireless *setting);
+

nm_setting_wireless_get_channel ()

+
guint32             nm_setting_wireless_get_channel     (NMSettingWireless *setting);
@@ -497,15 +486,16 @@ Creates a new Returns :

-
+
the "rate" property of the settingthe "channel" property of the setting

-

nm_setting_wireless_get_tx_power ()

-
guint32             nm_setting_wireless_get_tx_power    (NMSettingWireless *setting);
+

nm_setting_wireless_get_cloned_mac_address ()

+
const GByteArray *  nm_setting_wireless_get_cloned_mac_address
+                                                        (NMSettingWireless *setting);
@@ -516,7 +506,7 @@ Creates a new Returns :

-
+
the "tx-power" property of the settingthe "cloned-mac-address" property of the setting
@@ -542,8 +532,8 @@ Creates a new -

nm_setting_wireless_get_cloned_mac_address ()

-
const GByteArray *  nm_setting_wireless_get_cloned_mac_address
+

nm_setting_wireless_get_mac_address_blacklist ()

+
const GSList *      nm_setting_wireless_get_mac_address_blacklist
                                                         (NMSettingWireless *setting);
@@ -555,16 +545,17 @@ Creates a new Returns :

-
+
the "cloned-mac-address" property of the settingthe +"mac-address-blacklist" property of the setting. [element-type GLib.ByteArray] +

-

nm_setting_wireless_get_mac_address_blacklist ()

-
const GSList *      nm_setting_wireless_get_mac_address_blacklist
-                                                        (NMSettingWireless *setting);
+

nm_setting_wireless_get_mode ()

+
const char *        nm_setting_wireless_get_mode        (NMSettingWireless *setting);
@@ -575,9 +566,7 @@ Creates a new Returns :

-
+
the -"mac-address-blacklist" property of the setting. [element-type GLib.ByteArray] -the "mode" property of the setting
@@ -603,8 +592,9 @@ Creates a new -

nm_setting_wireless_get_security ()

-
const char *        nm_setting_wireless_get_security    (NMSettingWireless *setting);
+

nm_setting_wireless_get_num_seen_bssids ()

+
guint32             nm_setting_wireless_get_num_seen_bssids
+                                                        (NMSettingWireless *setting);
@@ -615,21 +605,15 @@ Creates a new Returns :

-
+
the "security" property of the settingthe number of BSSIDs in the previously seen BSSID list

-

nm_setting_wireless_add_seen_bssid ()

-
gboolean            nm_setting_wireless_add_seen_bssid  (NMSettingWireless *setting,
-                                                         const char *bssid);
-

-Adds a new WiFi AP's BSSID to the previously seen BSSID list of the setting. -NetworkManager tracks previously seen BSSIDs internally so this function -no longer has much use. -

+

nm_setting_wireless_get_rate ()

+
guint32             nm_setting_wireless_get_rate        (NMSettingWireless *setting);
@@ -639,22 +623,16 @@ no longer has much use. - - - - - +

bssid :

the new BSSID to add to the list

Returns :

-TRUE if bssid was already known, FALSE if notthe "rate" property of the setting

-

nm_setting_wireless_get_num_seen_bssids ()

-
guint32             nm_setting_wireless_get_num_seen_bssids
-                                                        (NMSettingWireless *setting);
+

nm_setting_wireless_get_security ()

+
const char *        nm_setting_wireless_get_security    (NMSettingWireless *setting);
@@ -665,7 +643,7 @@ no longer has much use. - +

Returns :

the number of BSSIDs in the previously seen BSSID listthe "security" property of the setting
@@ -697,62 +675,58 @@ no longer has much use.

-

nm_setting_wireless_ap_security_compatible ()

-
gboolean            nm_setting_wireless_ap_security_compatible
-                                                        (NMSettingWireless *s_wireless,
-                                                         NMSettingWirelessSecurity *s_wireless_sec,
-                                                         NM80211ApFlags ap_flags,
-                                                         NM80211ApSecurityFlags ap_wpa,
-                                                         NM80211ApSecurityFlags ap_rsn,
-                                                         NM80211Mode ap_mode);
-

-Given a NMSettingWireless and an optional NMSettingWirelessSecurity, -determine if the configuration given by the settings is compatible with -the security of an access point using that access point's capability flags -and mode. Useful for clients that wish to filter a set of connections -against a set of access points and determine which connections are -compatible with which access points. -

+

nm_setting_wireless_get_ssid ()

+
const GByteArray *  nm_setting_wireless_get_ssid        (NMSettingWireless *setting);
- - - - - - + - - - - - - - - - - + + + +

s_wireless :

a NMSettingWireless -

s_wireless_sec :

a NMSettingWirelessSecurity or NULL +

setting :

the NMSettingWireless

ap_flags :

the NM80211ApFlags of the given access point

ap_wpa :

the NM80211ApSecurityFlags of the given access point's WPA -capabilities

ap_rsn :

the NM80211ApSecurityFlags of the given access point's WPA2/RSN -capabilities

Returns :

the "ssid" property of the setting
+
+
+
+

nm_setting_wireless_get_tx_power ()

+
guint32             nm_setting_wireless_get_tx_power    (NMSettingWireless *setting);
+
++ - - + + - +

ap_mode :

the 802.11 mode of the AP, either Ad-Hoc or Infrastructure

setting :

the NMSettingWireless +

Returns :

-TRUE if the given settings are compatible with the access point's -security flags and mode, FALSE if they are not.the "tx-power" property of the setting
+
+
+

nm_setting_wireless_new ()

+
NMSetting *         nm_setting_wireless_new             (void);
+

+Creates a new NMSettingWireless object with default values. +

+
++ + + + +

Returns :

the new empty NMSettingWireless object. [transfer full] +
+

Property Details

@@ -899,6 +873,6 @@ devices support setting a static transmit power.
+ Generated by GTK-Doc V1.18
\ No newline at end of file -- cgit 1.3.0-6-gf8a5