From 7514efc2f38c9ace4557d4e69d68e7d380389030 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Fri, 26 Aug 2016 02:18:32 +0200 Subject: Imported Upstream version 1.4.0 --- docs/libnm/html/NMSettingWireless.html | 200 ++++++++++++++++++++++++--------- 1 file changed, 148 insertions(+), 52 deletions(-) (limited to 'docs/libnm/html/NMSettingWireless.html') diff --git a/docs/libnm/html/NMSettingWireless.html b/docs/libnm/html/NMSettingWireless.html index a58e847c..ff5b9e91 100644 --- a/docs/libnm/html/NMSettingWireless.html +++ b/docs/libnm/html/NMSettingWireless.html @@ -8,7 +8,7 @@ - + @@ -117,6 +117,13 @@ +const char * + + +nm_setting_wireless_get_generate_mac_address_mask () + + + const char * const * @@ -269,6 +276,12 @@ Read / Write + +gchar * +generate-mac-address-mask +Read / Write + + gboolean hidden Read / Write @@ -379,6 +392,10 @@ #define +NM_SETTING_WIRELESS_GENERATE_MAC_ADDRESS_MASK + + +#define NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST @@ -446,7 +463,7 @@ necessary for connection to 802.11 Wi-Fi networks.

nm_setting_wireless_new (void);

Creates a new NMSettingWireless object with default values.

-

Returns

+

Returns

the new empty NMSettingWireless object.

[transfer full]

@@ -457,7 +474,7 @@ nm_setting_wireless_new (voidGBytes * nm_setting_wireless_get_ssid (NMSettingWireless *setting);
-

Parameters

+

Parameters

@@ -472,7 +489,7 @@ nm_setting_wireless_get_ssid ( -

Returns

+

Returns

the “ssid” property of the setting.

[transfer none]

@@ -483,7 +500,7 @@ nm_setting_wireless_get_ssid (const char * nm_setting_wireless_get_mode (NMSettingWireless *setting);
-

Parameters

+

Parameters

@@ -498,7 +515,7 @@ nm_setting_wireless_get_mode ( -

Returns

+

Returns

the “mode” property of the setting

@@ -508,7 +525,7 @@ nm_setting_wireless_get_mode (const char * nm_setting_wireless_get_band (NMSettingWireless *setting);
-

Parameters

+

Parameters

@@ -523,7 +540,7 @@ nm_setting_wireless_get_band ( -

Returns

+

Returns

the “band” property of the setting

@@ -533,7 +550,7 @@ nm_setting_wireless_get_band (guint32 nm_setting_wireless_get_channel (NMSettingWireless *setting);
-

Parameters

+

Parameters

@@ -548,7 +565,7 @@ nm_setting_wireless_get_channel (
-

Returns

+

Returns

the “channel” property of the setting

@@ -558,7 +575,7 @@ nm_setting_wireless_get_channel (const char * nm_setting_wireless_get_bssid (NMSettingWireless *setting);
-

Parameters

+

Parameters

@@ -573,7 +590,7 @@ nm_setting_wireless_get_bssid (
-

Returns

+

Returns

the “bssid” property of the setting

@@ -583,7 +600,7 @@ nm_setting_wireless_get_bssid (guint32 nm_setting_wireless_get_rate (NMSettingWireless *setting);
-

Parameters

+

Parameters

@@ -598,7 +615,7 @@ nm_setting_wireless_get_rate ( -

Returns

+

Returns

the “rate” property of the setting

@@ -608,7 +625,7 @@ nm_setting_wireless_get_rate (guint32 nm_setting_wireless_get_tx_power (NMSettingWireless *setting);
-

Parameters

+

Parameters

@@ -623,7 +640,7 @@ nm_setting_wireless_get_tx_power (
-

Returns

+

Returns

the “tx-power” property of the setting

@@ -633,7 +650,7 @@ nm_setting_wireless_get_tx_power (const char * nm_setting_wireless_get_mac_address (NMSettingWireless *setting);
-

Parameters

+

Parameters

@@ -648,7 +665,7 @@ nm_setting_wireless_get_mac_address (
-

Returns

+

Returns

the “mac-address” property of the setting

@@ -659,7 +676,7 @@ nm_setting_wireless_get_mac_address (NMSettingWireless *setting);
-

Parameters

+

Parameters

@@ -674,18 +691,45 @@ nm_setting_wireless_get_cloned_mac_address
-

Returns

+

Returns

the “cloned-mac-address” property of the setting


+

nm_setting_wireless_get_generate_mac_address_mask ()

+
const char *
+nm_setting_wireless_get_generate_mac_address_mask
+                               (NMSettingWireless *setting);
+
+

Parameters

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

setting

the NMSettingWireless

 
+
+
+

Returns

+

the “generate-mac-address-mask” property of the setting

+
+

Since: 1.4

+
+
+

nm_setting_wireless_get_mac_address_blacklist ()

const char * const *
 nm_setting_wireless_get_mac_address_blacklist
                                (NMSettingWireless *setting);
-

Parameters

+

Parameters

@@ -700,7 +744,7 @@ nm_setting_wireless_get_mac_address_blacklist
-

Returns

+

Returns

the “mac-address-blacklist” property of the setting

@@ -711,7 +755,7 @@ nm_setting_wireless_get_mac_address_blacklist nm_setting_wireless_get_num_mac_blacklist_items (NMSettingWireless *setting);
-

Parameters

+

Parameters

@@ -726,7 +770,7 @@ nm_setting_wireless_get_num_mac_blacklist_items
-

Returns

+

Returns

the number of blacklisted MAC addresses

@@ -738,7 +782,7 @@ nm_setting_wireless_get_mac_blacklist_item (NMSettingWireless *setting, guint32 idx);
-

Parameters

+

Parameters

@@ -760,7 +804,7 @@ nm_setting_wireless_get_mac_blacklist_item
-

Returns

+

Returns

the blacklisted MAC address string (hex-digits-and-colons notation) at index idx

@@ -775,7 +819,7 @@ nm_setting_wireless_add_mac_blacklist_item const char *mac);

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

-

Parameters

+

Parameters

@@ -797,7 +841,7 @@ nm_setting_wireless_add_mac_blacklist_item
-

Returns

+

Returns

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

@@ -812,7 +856,7 @@ nm_setting_wireless_remove_mac_blacklist_item

Removes the MAC address at index idx from the blacklist.

-

Parameters

+

Parameters

@@ -844,7 +888,7 @@ nm_setting_wireless_remove_mac_blacklist_item_by_value

Removes the MAC address mac from the blacklist.

-

Parameters

+

Parameters

@@ -867,7 +911,7 @@ the blacklist

-

Returns

+

Returns

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

@@ -879,7 +923,7 @@ nm_setting_wireless_clear_mac_blacklist_items (NMSettingWireless *setting);

Removes all blacklisted MAC addresses.

-

Parameters

+

Parameters

@@ -900,7 +944,7 @@ nm_setting_wireless_clear_mac_blacklist_items
guint32
 nm_setting_wireless_get_mtu (NMSettingWireless *setting);
-

Parameters

+

Parameters

@@ -915,7 +959,7 @@ nm_setting_wireless_get_mtu ( -

Returns

+

Returns

the “mtu” property of the setting

@@ -925,7 +969,7 @@ nm_setting_wireless_get_mtu (gboolean nm_setting_wireless_get_hidden (NMSettingWireless *setting);
-

Parameters

+

Parameters

@@ -940,7 +984,7 @@ nm_setting_wireless_get_hidden (
-

Returns

+

Returns

the “hidden” property of the setting

@@ -950,7 +994,7 @@ nm_setting_wireless_get_hidden (guint32 nm_setting_wireless_get_powersave (NMSettingWireless *setting);
-

Parameters

+

Parameters

@@ -965,7 +1009,7 @@ nm_setting_wireless_get_powersave (
-

Returns

+

Returns

the “powersave” property of the setting

Since: 1.2

@@ -977,7 +1021,7 @@ nm_setting_wireless_get_powersave (NMSettingWireless *setting);
-

Parameters

+

Parameters

@@ -992,7 +1036,7 @@ nm_setting_wireless_get_mac_address_randomization
-

Returns

+

Returns

the “mac-address-randomization” property of the setting

@@ -1009,7 +1053,7 @@ NetworkManager now tracks previously seen BSSIDs internally so this function no longer has much use. Actually, changes you make using this function will not be preserved.

-

Parameters

+

Parameters

@@ -1031,7 +1075,7 @@ not be preserved.

-

Returns

+

Returns

TRUE if bssid was already known, FALSE if not

@@ -1043,7 +1087,7 @@ was already known, FALSE if not

nm_setting_wireless_get_num_seen_bssids (NMSettingWireless *setting);
-

Parameters

+

Parameters

@@ -1058,7 +1102,7 @@ nm_setting_wireless_get_num_seen_bssids
-

Returns

+

Returns

the number of BSSIDs in the previously seen BSSID list

@@ -1069,7 +1113,7 @@ nm_setting_wireless_get_num_seen_bssids nm_setting_wireless_get_seen_bssid (NMSettingWireless *setting, guint32 i);
-

Parameters

+

Parameters

@@ -1091,7 +1135,7 @@ nm_setting_wireless_get_seen_bssid (
-

Returns

+

Returns

the BSSID at index i

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

-

Parameters

+

Parameters

@@ -1158,7 +1202,7 @@ capabilities

-

Returns

+

Returns

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

@@ -1227,6 +1271,12 @@ security flags and mode, FALSE if they are not.


+

NM_SETTING_WIRELESS_GENERATE_MAC_ADDRESS_MASK

+
#define NM_SETTING_WIRELESS_GENERATE_MAC_ADDRESS_MASK "generate-mac-address-mask"
+
+
+
+

NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST

#define NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST "mac-address-blacklist"
 
@@ -1289,7 +1339,7 @@ for this connection.

enum NMSettingWirelessPowersave

These flags indicate whether wireless powersave must be enabled.

-

Members

+

Members

@@ -1385,8 +1435,50 @@ also requires the "band" property to be set.

The “cloned-mac-address” property

  “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.

+

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

+

Beside explicitly specifing a MAC address, the special values "preserve", "permanent", +"random" and "stable" are supported. +"preserve" means not to touch the MAC address on activation. +"permanent" means to use the permanent hardware address of the device. +"random" creates a random MAC address on each connect. +"stable" creates a hashed MAC address based on connection.stable-id (or +the connection's UUID) and a machine dependent key.

+

If unspecified, the value can be overwritten via global defaults, see manual +of NetworkManager.conf. If still unspecified, it defaults to "permanent".

+

On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated +"cloned-mac-address".

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “generate-mac-address-mask” property

+
  “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 +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, +while the unset bits are subject to randomization. +Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address +and only randomize the lower 3 bytes using the "random" or "stable" algorithm.

+

If the value contains one additional MAC address after the mask, +this address is used instead of the current MAC address to fill the bits +that shall not be randomized. For example, a value of +"FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address +to 68:F7:28, while the lower bits are randomized. A value of +"02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled +globally-administered, burned-in MAC address.

+

If the value contains more then one additional MAC addresses, one of +them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" +will create a fully scrambled MAC address, randomly locally or globally +administered.

Flags: Read / Write

Default value: NULL

@@ -1430,6 +1522,10 @@ the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (always randomize the MAC address).

+
+

NMSettingWireless:mac-address-randomization has been deprecated since version 1.4 and should not be used in newly-written code.

+

Deprecated by NMSettingWireless:cloned-mac-address property

+

Flags: Read / Write

Default value: 0

Since: 1.2

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

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