From afcd268ea7b1149fbfb66bce4eca659b675da0a2 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 12 Dec 2017 15:53:07 +0100 Subject: New upstream version 1.10.2 --- docs/libnm/html/NMSettingWireless.html | 154 ++++++++++++++++----------------- 1 file changed, 77 insertions(+), 77 deletions(-) (limited to 'docs/libnm/html/NMSettingWireless.html') diff --git a/docs/libnm/html/NMSettingWireless.html b/docs/libnm/html/NMSettingWireless.html index ca941e84..c88c400a 100644 --- a/docs/libnm/html/NMSettingWireless.html +++ b/docs/libnm/html/NMSettingWireless.html @@ -8,7 +8,7 @@ - + @@ -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 () @@ -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 () @@ -211,7 +211,7 @@ -gboolean +gboolean nm_setting_wireless_add_seen_bssid () @@ -219,7 +219,7 @@ -guint32 +guint32 nm_setting_wireless_get_num_seen_bssids () @@ -234,7 +234,7 @@ -gboolean +gboolean nm_setting_wireless_ap_security_compatible () @@ -254,88 +254,88 @@ -gchar * +gchar * band Read / Write -gchar * +gchar * bssid Read / Write -guint +guint channel Read / Write / Construct -gchar * +gchar * cloned-mac-address Read / Write -gchar * +gchar * generate-mac-address-mask 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 @@ -443,9 +443,9 @@

Object Hierarchy

-
    GEnum
+
    GEnum
     ╰── NMSettingWirelessPowersave
-    GObject
+    GObject
     ╰── NMSetting
         ╰── NMSettingWireless
 
@@ -464,14 +464,14 @@ nm_setting_wireless_new (voidCreates a new NMSettingWireless object with default values.

Returns

-

the new empty NMSettingWireless object.

+

the new empty NMSettingWireless object.

[transfer full]


nm_setting_wireless_get_ssid ()

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

Parameters

@@ -490,7 +490,7 @@ nm_setting_wireless_get_ssid (

Returns

-

the “ssid” property of the setting.

+

the “ssid” property of the setting.

[transfer none]

@@ -547,7 +547,7 @@ nm_setting_wireless_get_band (

nm_setting_wireless_get_channel ()

-
guint32
+
guint32
 nm_setting_wireless_get_channel (NMSettingWireless *setting);

Parameters

@@ -597,7 +597,7 @@ nm_setting_wireless_get_bssid (

nm_setting_wireless_get_rate ()

-
guint32
+
guint32
 nm_setting_wireless_get_rate (NMSettingWireless *setting);

Parameters

@@ -622,7 +622,7 @@ nm_setting_wireless_get_rate (

nm_setting_wireless_get_tx_power ()

-
guint32
+
guint32
 nm_setting_wireless_get_tx_power (NMSettingWireless *setting);

Parameters

@@ -751,7 +751,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);
@@ -780,7 +780,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

@@ -813,7 +813,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);
@@ -842,7 +842,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

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

@@ -881,7 +881,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);
@@ -912,7 +912,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.


@@ -941,7 +941,7 @@ nm_setting_wireless_clear_mac_blacklist_items

nm_setting_wireless_get_mtu ()

-
guint32
+
guint32
 nm_setting_wireless_get_mtu (NMSettingWireless *setting);

Parameters

@@ -966,7 +966,7 @@ nm_setting_wireless_get_mtu (

nm_setting_wireless_get_hidden ()

-
gboolean
+
gboolean
 nm_setting_wireless_get_hidden (NMSettingWireless *setting);

Parameters

@@ -991,7 +991,7 @@ nm_setting_wireless_get_hidden (

nm_setting_wireless_get_powersave ()

-
guint32
+
guint32
 nm_setting_wireless_get_powersave (NMSettingWireless *setting);

Parameters

@@ -1045,7 +1045,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. @@ -1076,14 +1076,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);
@@ -1111,7 +1111,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

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

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

@@ -1400,7 +1400,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 @@ -1413,7 +1413,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 @@ -1424,7 +1424,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 @@ -1435,7 +1435,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 device use this MAC address instead. This is known as MAC cloning or spoofing.

Beside explicitly specifying a MAC address, the special values "preserve", "permanent", @@ -1456,14 +1456,14 @@ of NetworkManager.conf. If still unspecified, it defaults to "preserve"


The “generate-mac-address-mask” property

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

With “cloned-mac-address” setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address.

-

If the property is NULL, it is eligible to be overwritten by a default -connection setting. If the value is still NULL or an empty string, the +

If the property is NULL, it is eligible to be overwritten by a default +connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address.

If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, @@ -1487,8 +1487,8 @@ administered.


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

@@ -1509,7 +1509,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").

@@ -1518,7 +1518,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 @@ -1536,7 +1536,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

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

@@ -1554,7 +1554,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 @@ -1567,7 +1567,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 @@ -1578,7 +1578,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 @@ -1590,14 +1590,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.

@@ -1607,6 +1607,6 @@ devices support setting a static transmit power.

+
Generated by GTK-Doc V1.26
\ No newline at end of file -- cgit 1.3.0-6-gf8a5

s_wireless_sec

a NMSettingWirelessSecurity or NULL

a NMSettingWirelessSecurity or NULL