From 45cb5bb3c0e6edb887cf69b417fcaf7053814a9b Mon Sep 17 00:00:00 2001 From: Aron Xu Date: Tue, 20 Dec 2016 20:06:37 +0800 Subject: Imported Upstream version 1.4.4 --- docs/libnm-util/html/NMSettingWireless.html | 194 ++++++++++++++-------------- 1 file changed, 97 insertions(+), 97 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 23a3312f..7ab84a7b 100644 --- a/docs/libnm-util/html/NMSettingWireless.html +++ b/docs/libnm-util/html/NMSettingWireless.html @@ -3,7 +3,7 @@ NMSettingWireless: libnm-util Reference Manual - + @@ -35,7 +35,7 @@

Functions

-
+
@@ -43,7 +43,7 @@ - - - - -
-GQuark +GQuark nm_setting_wireless_error_quark () @@ -58,7 +58,7 @@
const GByteArray * +const GByteArray * nm_setting_wireless_get_ssid () @@ -80,14 +80,14 @@
-guint32 +guint32 nm_setting_wireless_get_channel ()
const GByteArray * +const GByteArray * nm_setting_wireless_get_bssid () @@ -95,7 +95,7 @@
-guint32 +guint32 nm_setting_wireless_get_rate () @@ -103,28 +103,28 @@
-guint32 +guint32 nm_setting_wireless_get_tx_power ()
const GByteArray * +const GByteArray * nm_setting_wireless_get_mac_address ()
const GByteArray * +const GByteArray * nm_setting_wireless_get_cloned_mac_address ()
const GSList * +const GSList * nm_setting_wireless_get_mac_address_blacklist () @@ -132,7 +132,7 @@
-guint32 +guint32 nm_setting_wireless_get_num_mac_blacklist_items () @@ -147,7 +147,7 @@
-gboolean +gboolean nm_setting_wireless_add_mac_blacklist_item () @@ -163,7 +163,7 @@
-gboolean +gboolean nm_setting_wireless_remove_mac_blacklist_item_by_value () @@ -179,7 +179,7 @@
-guint32 +guint32 nm_setting_wireless_get_mtu () @@ -187,7 +187,7 @@
-gboolean +gboolean nm_setting_wireless_get_hidden () @@ -195,7 +195,7 @@
-guint32 +guint32 nm_setting_wireless_get_powersave () @@ -203,7 +203,7 @@
-gboolean +gboolean nm_setting_wireless_add_seen_bssid () @@ -211,7 +211,7 @@
-guint32 +guint32 nm_setting_wireless_get_num_seen_bssids () @@ -226,7 +226,7 @@
-gboolean +gboolean nm_setting_wireless_ap_security_compatible () @@ -244,7 +244,7 @@

Properties

-
+
@@ -253,7 +253,7 @@ +gchar * @@ -264,7 +264,7 @@ - + @@ -275,7 +275,7 @@ - + @@ -293,28 +293,28 @@ +gchar * - + - + - + +gchar * @@ -331,7 +331,7 @@ - + @@ -340,7 +340,7 @@

Types and Values

-
-gchar * band Read / Write
Read / Write
guintguint channel Read / Write / Construct
Read / Write
gbooleangboolean hidden Read / Write
-gchar * mode Read / Write
guintguint mtu Read / Write / Construct
guintguint powersave Read / Write
guintguint rate Read / Write / Construct
-gchar * security Read / Write
Read / Write
guintguint tx-power Read / Write / Construct
+
@@ -437,7 +437,7 @@

Object Hierarchy

    GEnum
     ╰── NMSettingWirelessError
-    GObject
+    GObject
     ╰── NMSetting
         ╰── NMSettingWireless
@@ -456,7 +456,7 @@ necessary for connection to 802.11 Wi-Fi networks.

Functions

nm_setting_wireless_error_quark ()

-
GQuark
+
GQuark
 nm_setting_wireless_error_quark (void);

 
Registers an error quark for NMSettingWireless if necessary.

 

@@ -479,11 +479,11 @@ nm_setting_wireless_new (void
 

 
nm_setting_wireless_get_ssid ()

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

 

 
Parameters

-
+
@@ -508,7 +508,7 @@ nm_setting_wireless_get_ssid (NMSettingWireless *setting);

Parameters

-
+
@@ -533,7 +533,7 @@ nm_setting_wireless_get_mode (NMSettingWireless *setting);

Parameters

-
+
@@ -554,11 +554,11 @@ nm_setting_wireless_get_band (

nm_setting_wireless_get_channel ()

-
guint32
+
guint32
 nm_setting_wireless_get_channel (NMSettingWireless *setting);

 

 
Parameters

-
+
@@ -579,11 +579,11 @@ nm_setting_wireless_get_channel (

nm_setting_wireless_get_bssid ()

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

 

 
Parameters

-
+
@@ -604,11 +604,11 @@ nm_setting_wireless_get_bssid (

nm_setting_wireless_get_rate ()

-
guint32
+
guint32
 nm_setting_wireless_get_rate (NMSettingWireless *setting);

 

 
Parameters

-
+
@@ -629,11 +629,11 @@ nm_setting_wireless_get_rate (

nm_setting_wireless_get_tx_power ()

-
guint32
+
guint32
 nm_setting_wireless_get_tx_power (NMSettingWireless *setting);

 

 
Parameters

-
+
@@ -654,11 +654,11 @@ nm_setting_wireless_get_tx_power (

nm_setting_wireless_get_mac_address ()

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

 

 
Parameters

-
+
@@ -679,12 +679,12 @@ nm_setting_wireless_get_mac_address (

nm_setting_wireless_get_cloned_mac_address ()

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

 

 
Parameters

-
+
@@ -705,12 +705,12 @@ nm_setting_wireless_get_cloned_mac_address

nm_setting_wireless_get_mac_address_blacklist ()

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

 

 
Parameters

-
+
@@ -733,12 +733,12 @@ nm_setting_wireless_get_mac_address_blacklist

nm_setting_wireless_get_num_mac_blacklist_items ()

-
guint32
+
guint32
 nm_setting_wireless_get_num_mac_blacklist_items
                                (NMSettingWireless *setting);

 

 
Parameters

-
+
@@ -763,10 +763,10 @@ nm_setting_wireless_get_num_mac_blacklist_items 
const char *
 nm_setting_wireless_get_mac_blacklist_item
                                (NMSettingWireless *setting,
-                                guint32 idx);
+ guint32 idx);

Parameters

-
+
@@ -797,14 +797,14 @@ at index idx

nm_setting_wireless_add_mac_blacklist_item ()

-
gboolean
+
gboolean
 nm_setting_wireless_add_mac_blacklist_item
                                (NMSettingWireless *setting,
                                 const char *mac);

 
Adds a new MAC address to the “mac-address-blacklist” property.

 

 
Parameters

-
+
@@ -826,7 +826,7 @@ nm_setting_wireless_add_mac_blacklist_item

Returns

-

TRUE if the MAC address was added; FALSE if the MAC address +

TRUE if the MAC address was added; FALSE if the MAC address is invalid or was already present

Since: 0.9.10

@@ -837,12 +837,12 @@ is invalid or was already present

void
 nm_setting_wireless_remove_mac_blacklist_item
                                (NMSettingWireless *setting,
-                                guint32 idx);
+ guint32 idx);

Removes the MAC address at index idx from the blacklist.

Parameters

-
+
@@ -867,7 +867,7 @@ nm_setting_wireless_remove_mac_blacklist_item

nm_setting_wireless_remove_mac_blacklist_item_by_value ()

-
gboolean
+
gboolean
 nm_setting_wireless_remove_mac_blacklist_item_by_value
                                (NMSettingWireless *setting,
                                 const char *mac);

@@ -875,7 +875,7 @@ nm_setting_wireless_remove_mac_blacklist_item_by_value
  from the blacklist.

 

 
Parameters

-
+
@@ -898,7 +898,7 @@ the blacklist

Returns

-

TRUE if the MAC address was found and removed; FALSE if it was not.

+

TRUE if the MAC address was found and removed; FALSE if it was not.

Since: 0.9.10

@@ -911,7 +911,7 @@ nm_setting_wireless_clear_mac_blacklist_items

Removes all blacklisted MAC addresses.

Parameters

-
+
@@ -929,11 +929,11 @@ nm_setting_wireless_clear_mac_blacklist_items

nm_setting_wireless_get_mtu ()

-
guint32
+
guint32
 nm_setting_wireless_get_mtu (NMSettingWireless *setting);

 

 
Parameters

-
+
@@ -954,11 +954,11 @@ nm_setting_wireless_get_mtu (

nm_setting_wireless_get_hidden ()

-
gboolean
+
gboolean
 nm_setting_wireless_get_hidden (NMSettingWireless *setting);

 

 
Parameters

-
+
@@ -979,11 +979,11 @@ nm_setting_wireless_get_hidden (

nm_setting_wireless_get_powersave ()

-
guint32
+
guint32
 nm_setting_wireless_get_powersave (NMSettingWireless *setting);

 

 
Parameters

-
+
@@ -1005,7 +1005,7 @@ nm_setting_wireless_get_powersave (

nm_setting_wireless_add_seen_bssid ()

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

 
Adds a new Wi-Fi AP's BSSID to the previously seen BSSID list of the setting.
@@ -1014,7 +1014,7 @@ no longer has much use. Actually, changes you make using this function will
 not be preserved.

 

 
Parameters

-
+
@@ -1036,19 +1036,19 @@ not be preserved.

Returns

-

TRUE if bssid -was already known, FALSE if not

+

TRUE if bssid +was already known, FALSE if not

nm_setting_wireless_get_num_seen_bssids ()

-
guint32
+
guint32
 nm_setting_wireless_get_num_seen_bssids
                                (NMSettingWireless *setting);

 

 
Parameters

-
+
@@ -1071,10 +1071,10 @@ nm_setting_wireless_get_num_seen_bssids

nm_setting_wireless_get_seen_bssid ()

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

Parameters

-
+
@@ -1103,7 +1103,7 @@ nm_setting_wireless_get_seen_bssid (

nm_setting_wireless_ap_security_compatible ()

-
gboolean
+
gboolean
 nm_setting_wireless_ap_security_compatible
                                (NMSettingWireless *s_wireless,
                                 NMSettingWirelessSecurity *s_wireless_sec,
@@ -1119,7 +1119,7 @@ against a set of access points and determine which connections are
 compatible with which access points.

 

 
Parameters

-
+
@@ -1133,7 +1133,7 @@ compatible with which access points.

 - + @@ -1163,8 +1163,8 @@ capabilities

Returns

-

TRUE if the given settings are compatible with the access point's -security flags and mode, FALSE if they are not.

+

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

@@ -1179,7 +1179,7 @@ the presence of NM_SETTING_WIRELESS_SECURITY_SETTING_NAME in the connection.

Parameters

-

s_wireless_sec

a NMSettingWirelessSecurity or NULL

a NMSettingWirelessSecurity or NULL

  
+
@@ -1210,7 +1210,7 @@ the presence of NM_SETTING_WIRELESS_SECURITY_SETTING_NAME in the connection.

enum NMSettingWirelessError

Members

-
+
@@ -1384,7 +1384,7 @@ for this connection.

Property Details

The “band” property

-
  “band”                     gchar *
+
  “band”                     gchar *

802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not @@ -1407,7 +1407,7 @@ creating an Ad-Hoc network and is unlikely to in the future.

The “channel” property

-
  “channel”                  guint
+
  “channel”                  guint

Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property @@ -1426,8 +1426,8 @@ of its permanent MAC address. This is known as MAC cloning or spoofing.

The “hidden” property

-
  “hidden”                   gboolean
-

If TRUE, indicates this network is a non-broadcasting network that hides +

  “hidden”                   gboolean
+

If TRUE, indicates this network is a non-broadcasting network that hides its SSID. In this case various workarounds may take place, such as probe-scanning the SSID for more reliable network discovery. However, these workarounds expose inherent insecurities with hidden SSID networks, @@ -1456,7 +1456,7 @@ standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").

The “mode” property

-
  “mode”                     gchar *
+
  “mode”                     gchar *

Wi-Fi network mode; one of "infrastructure", "adhoc" or "ap". If blank, infrastructure is assumed.

Flags: Read / Write

@@ -1465,7 +1465,7 @@ infrastructure is assumed.

The “mtu” property

-
  “mtu”                      guint
+
  “mtu”                      guint

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.

Flags: Read / Write / Construct

@@ -1474,9 +1474,9 @@ breaking larger packets up into multiple Ethernet frames.

The “powersave” property

-
  “powersave”                guint
-

If set to FALSE, Wi-Fi power saving behavior is disabled. If set to -TRUE, Wi-Fi power saving behavior is enabled. All other values are +

  “powersave”                guint
+

If set to FALSE, Wi-Fi power saving behavior is disabled. If set to +TRUE, Wi-Fi power saving behavior is enabled. All other values are reserved. Note that even though only boolean values are allowed, the property type is an unsigned integer to allow for future expansion.

Flags: Read / Write

@@ -1486,7 +1486,7 @@ property type is an unsigned integer to allow for future expansion.

The “rate” property

-
  “rate”                     guint
+
  “rate”                     guint

If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices @@ -1497,7 +1497,7 @@ support setting a static bitrate.

The “security” property

-
  “security”                 gchar *
+
  “security”                 gchar *

If the wireless connection has any security restrictions, like 802.1x, WEP, or WPA, set this property to NM_SETTING_WIRELESS_SECURITY_SETTING_NAME and ensure the connection @@ -1533,7 +1533,7 @@ preserved.

The “tx-power” property

-
  “tx-power”                 guint
+
  “tx-power”                 guint

If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.

-- cgit 1.3.0-6-gf8a5