From 263bf4c0c89bb88dc995acd9a6a2de9095fbd461 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 23 Aug 2011 19:16:47 +0200 Subject: Imported Upstream version 0.9.0 --- docs/libnm-util/html/NMSettingWireless.html | 401 +++++++++++++++++++++++++--- 1 file changed, 363 insertions(+), 38 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 21d51d29..c719a248 100644 --- a/docs/libnm-util/html/NMSettingWireless.html +++ b/docs/libnm-util/html/NMSettingWireless.html @@ -35,13 +35,16 @@

NMSettingWireless

-

NMSettingWireless

+

NMSettingWireless — Describes connection properties for 802.11 WiFi networks

Synopsis

-
#define             NM_SETTING_WIRELESS_SETTING_NAME
+
+#include <nm-setting-wireless.h>
+
+#define             NM_SETTING_WIRELESS_SETTING_NAME
 enum                NMSettingWirelessError;
 #define             NM_TYPE_SETTING_WIRELESS_ERROR
 #define             NM_SETTING_WIRELESS_ERROR
@@ -55,6 +58,7 @@ enum                NM_SETTING_WIRELESS_TX_POWER
 #define             NM_SETTING_WIRELESS_MAC_ADDRESS
 #define             NM_SETTING_WIRELESS_CLONED_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
@@ -74,6 +78,8 @@ const GByteArray *  nm_setting_wireless_get_mac_address (NMSettingWireless *setting);
 const GByteArray *  nm_setting_wireless_get_cloned_mac_address
                                                         (NMSettingWireless *setting);
+const GSList *      nm_setting_wireless_get_mac_address_blacklist
+                                                        (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,
@@ -111,6 +117,7 @@ const char *        channel"                  guint                 : Read / Write / Construct
   "cloned-mac-address"       GArray_guchar_*       : Read / Write
   "mac-address"              GArray_guchar_*       : Read / Write
+  "mac-address-blacklist"    GSList_gchararray_*   : Read / Write
   "mode"                     gchar*                : Read / Write
   "mtu"                      guint                 : Read / Write / Construct
   "rate"                     guint                 : Read / Write / Construct
@@ -123,6 +130,8 @@ const char *        
 
Description

 

+The NMSettingWireless object is a NMSetting subclass that describes properties
+necessary for connection to 802.11 WiFi networks.
@@ -137,8 +146,7 @@ const char *

enum NMSettingWirelessError

-
typedef enum
-{
+
typedef enum {
 	NM_SETTING_WIRELESS_ERROR_UNKNOWN = 0,
 	NM_SETTING_WIRELESS_ERROR_INVALID_PROPERTY,
 	NM_SETTING_WIRELESS_ERROR_MISSING_PROPERTY,
@@ -146,8 +154,39 @@ const char *        
++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+


NM_SETTING_WIRELESS_ERROR_UNKNOWN
unknown or unclassified error
+
NM_SETTING_WIRELESS_ERROR_INVALID_PROPERTY
the property was invalid
+
NM_SETTING_WIRELESS_ERROR_MISSING_PROPERTY
the property was missing and is
+required
+
NM_SETTING_WIRELESS_ERROR_MISSING_SECURITY_SETTING
property values require
+the presence of an NMSettingWirelessSecurity object in the connection
+
NM_SETTING_WIRELESS_ERROR_CHANNEL_REQUIRES_BAND
the property channel was
+set to a value that requires the "band" property to be set
+
@@ -170,7 +209,15 @@ const char *

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.
@@ -246,6 +293,14 @@ const char * +

NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST

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

+

+
+
+

NM_SETTING_WIRELESS_MTU

#define NM_SETTING_WIRELESS_MTU         "mtu"
@@ -274,6 +329,7 @@ const char * #define NM_SETTING_WIRELESS_MODE_ADHOC "adhoc"

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

@@ -282,6 +338,8 @@ const char * #define NM_SETTING_WIRELESS_MODE_INFRA "infrastructure"

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

@@ -319,85 +377,248 @@ const char *

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] +

nm_setting_wireless_get_ssid ()

const GByteArray *  nm_setting_wireless_get_ssid        (NMSettingWireless *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the "ssid" property of the setting

nm_setting_wireless_get_mode ()

const char *        nm_setting_wireless_get_mode        (NMSettingWireless *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the "mode" property of the setting

nm_setting_wireless_get_band ()

const char *        nm_setting_wireless_get_band        (NMSettingWireless *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the "band" property of the setting

nm_setting_wireless_get_channel ()

guint32             nm_setting_wireless_get_channel     (NMSettingWireless *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the "channel" property of the setting

nm_setting_wireless_get_bssid ()

const GByteArray *  nm_setting_wireless_get_bssid       (NMSettingWireless *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the "bssid" property of the setting

nm_setting_wireless_get_rate ()

guint32             nm_setting_wireless_get_rate        (NMSettingWireless *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the "rate" property of the setting

nm_setting_wireless_get_tx_power ()

guint32             nm_setting_wireless_get_tx_power    (NMSettingWireless *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the "tx-power" property of the setting

nm_setting_wireless_get_mac_address ()

const GByteArray *  nm_setting_wireless_get_mac_address (NMSettingWireless *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the "mac-address" property of the setting

nm_setting_wireless_get_cloned_mac_address ()

const GByteArray *  nm_setting_wireless_get_cloned_mac_address
                                                         (NMSettingWireless *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the "cloned-mac-address" property of the setting
+
+
+
+

nm_setting_wireless_get_mac_address_blacklist ()

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

setting :

the NMSettingWireless +

Returns :

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

nm_setting_wireless_get_mtu ()

guint32             nm_setting_wireless_get_mtu         (NMSettingWireless *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the "mtu" property of the setting

nm_setting_wireless_get_security ()

const char *        nm_setting_wireless_get_security    (NMSettingWireless *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the "security" property of the setting
@@ -405,23 +626,74 @@ const char * 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.

+
++ + + + + + + + + + + + + + +

setting :

the NMSettingWireless +

bssid :

the new BSSID to add to the list

Returns :

 +TRUE if bssid was already known, FALSE if not

nm_setting_wireless_get_num_seen_bssids ()

guint32             nm_setting_wireless_get_num_seen_bssids
                                                         (NMSettingWireless *setting);
-

-

+
++ + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the number of BSSIDs in the previously seen BSSID list

nm_setting_wireless_get_seen_bssid ()

const char *        nm_setting_wireless_get_seen_bssid  (NMSettingWireless *setting,
                                                          guint32 i);
-

-

+
++ + + + + + + + + + + + + + +

setting :

the NMSettingWireless +

i :

index of a BSSID in the previously seen BSSID list

Returns :

the BSSID at index i +
@@ -434,7 +706,52 @@ const char * 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. +

+
++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

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 :

 +TRUE if the given settings are compatible with the access point's +security flags and mode, FALSE if they are not.
@@ -496,6 +813,17 @@ of the device (i.e. MAC spoofing).
+

The "mac-address-blacklist" property

+
  "mac-address-blacklist"    GSList_gchararray_*   : Read / Write
+

+If specified, this connection will never apply to the WiFi device +whose permanent MAC address matches an address in the list. Each +MAC address is in the standard hex-digits-and-colons notation. +(00:11:22:33:44:55). +

+
+
+

The "mode" property

  "mode"                     gchar*                : Read / Write

@@ -544,11 +872,8 @@ the connection contains a valid 802-11-wireless-security setting.

A list of BSSIDs (each BSSID formatted as a MAC address like '00:11:22:33:44:55') that have been detected as part of the WiFI network. -The settings service will usually populate this property by periodically -asking NetworkManager what the device's current AP is while connected -to the network (or monitoring the device's 'active-ap' property) and -adding the current AP'sBSSID to this list. This list helps NetworkManager -find hidden APs by matching up scan results with the BSSIDs in this list. +NetworkManager internally tracks previously seen BSSIDs so this property +is no longer of much use.

-- cgit 1.3.0-6-gf8a5