From d9c99a29a0d3384c9c3d2adce430f5cb1134ab6a Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Wed, 30 Mar 2016 00:56:30 +0200 Subject: Imported Upstream version 1.1.92 --- docs/libnm/html/NMSettingWireless.html | 138 ++++++++++++++++----------------- 1 file changed, 69 insertions(+), 69 deletions(-) (limited to 'docs/libnm/html/NMSettingWireless.html') diff --git a/docs/libnm/html/NMSettingWireless.html b/docs/libnm/html/NMSettingWireless.html index 9106fec5..c75e3666 100644 --- a/docs/libnm/html/NMSettingWireless.html +++ b/docs/libnm/html/NMSettingWireless.html @@ -51,7 +51,7 @@ -GBytes * +GBytes * nm_setting_wireless_get_ssid () @@ -73,7 +73,7 @@ -guint32 +guint32 nm_setting_wireless_get_channel () @@ -88,7 +88,7 @@ -guint32 +guint32 nm_setting_wireless_get_rate () @@ -96,7 +96,7 @@ -guint32 +guint32 nm_setting_wireless_get_tx_power () @@ -125,7 +125,7 @@ -guint32 +guint32 nm_setting_wireless_get_num_mac_blacklist_items () @@ -140,7 +140,7 @@ -gboolean +gboolean nm_setting_wireless_add_mac_blacklist_item () @@ -156,7 +156,7 @@ -gboolean +gboolean nm_setting_wireless_remove_mac_blacklist_item_by_value () @@ -172,7 +172,7 @@ -guint32 +guint32 nm_setting_wireless_get_mtu () @@ -180,7 +180,7 @@ -gboolean +gboolean nm_setting_wireless_get_hidden () @@ -188,7 +188,7 @@ -guint32 +guint32 nm_setting_wireless_get_powersave () @@ -204,7 +204,7 @@ -gboolean +gboolean nm_setting_wireless_add_seen_bssid () @@ -212,7 +212,7 @@ -guint32 +guint32 nm_setting_wireless_get_num_seen_bssids () @@ -227,7 +227,7 @@ -gboolean +gboolean nm_setting_wireless_ap_security_compatible () @@ -247,82 +247,82 @@ -gchar * +gchar * band Read / Write -gchar * +gchar * bssid Read / Write -guint +guint channel Read / Write / Construct -gchar * +gchar * cloned-mac-address Read / Write -gboolean +gboolean hidden Read / Write -gchar * +gchar * mac-address Read / Write -GStrv +GStrv mac-address-blacklist Read / Write -guint +guint mac-address-randomization Read / Write -gchar * +gchar * mode Read / Write -guint +guint mtu Read / Write / Construct -guint +guint powersave Read / Write -guint +guint rate Read / Write / Construct -GStrv +GStrv seen-bssids Read / Write -GBytes * +GBytes * ssid Read / Write -guint +guint tx-power Read / Write / Construct @@ -422,9 +422,9 @@

Object Hierarchy

-
    GEnum
+
    GEnum
     ╰── NMSettingWirelessPowersave
-    GObject
+    GObject
     ╰── NMSetting
         ╰── NMSettingWireless
 
@@ -450,7 +450,7 @@ nm_setting_wireless_new (void

nm_setting_wireless_get_ssid ()

-
GBytes *
+
GBytes *
 nm_setting_wireless_get_ssid (NMSettingWireless *setting);

Parameters

@@ -526,7 +526,7 @@ nm_setting_wireless_get_band (

nm_setting_wireless_get_channel ()

-
guint32
+
guint32
 nm_setting_wireless_get_channel (NMSettingWireless *setting);

Parameters

@@ -576,7 +576,7 @@ nm_setting_wireless_get_bssid (

nm_setting_wireless_get_rate ()

-
guint32
+
guint32
 nm_setting_wireless_get_rate (NMSettingWireless *setting);

Parameters

@@ -601,7 +601,7 @@ nm_setting_wireless_get_rate (

nm_setting_wireless_get_tx_power ()

-
guint32
+
guint32
 nm_setting_wireless_get_tx_power (NMSettingWireless *setting);

Parameters

@@ -703,7 +703,7 @@ 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);
@@ -732,7 +732,7 @@ nm_setting_wireless_get_num_mac_blacklist_items
const char *
 nm_setting_wireless_get_mac_blacklist_item
                                (NMSettingWireless *setting,
-                                guint32 idx);
+ guint32 idx);

Parameters

@@ -765,7 +765,7 @@ at index idx

nm_setting_wireless_add_mac_blacklist_item ()

-
gboolean
+
gboolean
 nm_setting_wireless_add_mac_blacklist_item
                                (NMSettingWireless *setting,
                                 const char *mac);
@@ -794,7 +794,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

@@ -804,7 +804,7 @@ 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.

@@ -833,7 +833,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);
@@ -864,7 +864,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.


@@ -893,7 +893,7 @@ nm_setting_wireless_clear_mac_blacklist_items

nm_setting_wireless_get_mtu ()

-
guint32
+
guint32
 nm_setting_wireless_get_mtu (NMSettingWireless *setting);

Parameters

@@ -918,7 +918,7 @@ nm_setting_wireless_get_mtu (

nm_setting_wireless_get_hidden ()

-
gboolean
+
gboolean
 nm_setting_wireless_get_hidden (NMSettingWireless *setting);

Parameters

@@ -943,7 +943,7 @@ nm_setting_wireless_get_hidden (

nm_setting_wireless_get_powersave ()

-
guint32
+
guint32
 nm_setting_wireless_get_powersave (NMSettingWireless *setting);

Parameters

@@ -997,7 +997,7 @@ setting


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. @@ -1028,14 +1028,14 @@ 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);
@@ -1063,7 +1063,7 @@ 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

@@ -1095,7 +1095,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,
@@ -1125,7 +1125,7 @@ compatible with which access points.

- + @@ -1155,8 +1155,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.

@@ -1340,7 +1340,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 @@ -1353,7 +1353,7 @@ capability and may not work with all drivers.


The “bssid” property

-
  “bssid”                    gchar *
+
  “bssid”                    gchar *

If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when @@ -1364,7 +1364,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 @@ -1375,7 +1375,7 @@ also requires the "band" property to be set.


The “cloned-mac-address” property

-
  “cloned-mac-address”       gchar *
+
  “cloned-mac-address”       gchar *

If specified, request that the Wi-Fi device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.

Flags: Read / Write

@@ -1384,8 +1384,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, @@ -1396,7 +1396,7 @@ and thus hidden SSID networks should be used with caution.


The “mac-address” property

-
  “mac-address”              gchar *
+
  “mac-address”              gchar *

If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).

@@ -1406,7 +1406,7 @@ address of the device (i.e. MAC spoofing).


The “mac-address-blacklist” property

-
  “mac-address-blacklist”    GStrv
+
  “mac-address-blacklist”    GStrv

A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").

@@ -1415,7 +1415,7 @@ standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").


The “mac-address-randomization” property

-
  “mac-address-randomization” guint
+
  “mac-address-randomization” guint

One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (never @@ -1428,7 +1428,7 @@ randomize the MAC address), or

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

@@ -1437,7 +1437,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

@@ -1446,7 +1446,7 @@ breaking larger packets up into multiple Ethernet frames.


The “powersave” property

-
  “powersave”                guint
+
  “powersave”                guint

One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (don't touch currently @@ -1459,7 +1459,7 @@ globally configured value). All other values are reserved.


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 @@ -1470,7 +1470,7 @@ support setting a static bitrate.


The “seen-bssids” property

-
  “seen-bssids”              GStrv
+
  “seen-bssids”              GStrv

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 Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The @@ -1482,14 +1482,14 @@ preserved.


The “ssid” property

-
  “ssid”                     GBytes *
+
  “ssid”                     GBytes *

SSID of the Wi-Fi network. Must be specified.

Flags: Read / Write


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

s_wireless_sec

a NMSettingWirelessSecurity or NULL

a NMSettingWirelessSecurity or NULL