NMSettingWireless: libnm Reference Manual

- - -

NMSettingWireless

NMSettingWireless — Describes connection properties for 802.11 Wi-Fi networks

Functions

---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-NMSetting * -	-nm_setting_wireless_new () -
-GBytes * -	-nm_setting_wireless_get_ssid () -
const char * -	-nm_setting_wireless_get_mode () -
const char * -	-nm_setting_wireless_get_band () -
-guint32 -	-nm_setting_wireless_get_channel () -
const char * -	-nm_setting_wireless_get_bssid () -
-guint32 -	-nm_setting_wireless_get_rate () -
-guint32 -	-nm_setting_wireless_get_tx_power () -
const char * -	-nm_setting_wireless_get_mac_address () -
const char * -	-nm_setting_wireless_get_cloned_mac_address () -
const char * -	-nm_setting_wireless_get_generate_mac_address_mask () -
const char const -	-nm_setting_wireless_get_mac_address_blacklist () -
-guint32 -	-nm_setting_wireless_get_num_mac_blacklist_items () -
const char * -	-nm_setting_wireless_get_mac_blacklist_item () -
-gboolean -	-nm_setting_wireless_add_mac_blacklist_item () -
-void -	-nm_setting_wireless_remove_mac_blacklist_item () -
-gboolean -	-nm_setting_wireless_remove_mac_blacklist_item_by_value () -
-void -	-nm_setting_wireless_clear_mac_blacklist_items () -
-guint32 -	-nm_setting_wireless_get_mtu () -
-gboolean -	-nm_setting_wireless_get_hidden () -
-guint32 -	-nm_setting_wireless_get_powersave () -
-NMSettingMacRandomization -	-nm_setting_wireless_get_mac_address_randomization () -
-gboolean -	-nm_setting_wireless_add_seen_bssid () -
-guint32 -	-nm_setting_wireless_get_num_seen_bssids () -
const char * -	-nm_setting_wireless_get_seen_bssid () -
-gboolean -	-nm_setting_wireless_ap_security_compatible () -
-NMSettingWirelessWakeOnWLan -	-nm_setting_wireless_get_wake_on_wlan () -
-NMTernary -	-nm_setting_wireless_get_ap_isolation () -

Types and Values

---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

#define	NM_SETTING_WIRELESS_SETTING_NAME
enum	NMSettingWirelessWakeOnWLan
#define	NM_SETTING_WIRELESS_SSID
#define	NM_SETTING_WIRELESS_MODE
#define	NM_SETTING_WIRELESS_BAND
#define	NM_SETTING_WIRELESS_CHANNEL
#define	NM_SETTING_WIRELESS_BSSID
#define	NM_SETTING_WIRELESS_RATE
#define	NM_SETTING_WIRELESS_TX_POWER
#define	NM_SETTING_WIRELESS_MAC_ADDRESS
#define	NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS
#define	NM_SETTING_WIRELESS_GENERATE_MAC_ADDRESS_MASK
#define	NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST
#define	NM_SETTING_WIRELESS_MTU
#define	NM_SETTING_WIRELESS_SEEN_BSSIDS
#define	NM_SETTING_WIRELESS_HIDDEN
#define	NM_SETTING_WIRELESS_POWERSAVE
#define	NM_SETTING_WIRELESS_MAC_ADDRESS_RANDOMIZATION
#define	NM_SETTING_WIRELESS_WAKE_ON_WLAN
#define	NM_SETTING_WIRELESS_AP_ISOLATION
#define	NM_SETTING_WIRELESS_MODE_ADHOC
#define	NM_SETTING_WIRELESS_MODE_AP
#define	NM_SETTING_WIRELESS_MODE_INFRA
#define	NM_SETTING_WIRELESS_MODE_MESH
enum	NMSettingWirelessPowersave

Object Hierarchy

    GEnum
-    ╰── NMSettingWirelessPowersave
-    GFlags
-    ╰── NMSettingWirelessWakeOnWLan
-

Description

The NMSettingWireless object is a NMSetting subclass that describes properties -necessary for connection to 802.11 Wi-Fi networks.

Functions

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 ()

GBytes *
-nm_setting_wireless_get_ssid (NMSettingWireless *setting);

Parameters

----- - - - - - -

setting

setting	the NMSettingWireless
idx	the zero-based index of the MAC address entry

setting	the NMSettingWireless
mac	the MAC address string (hex-digits-and-colons notation) to blacklist

setting	the NMSettingWireless
idx	index number of the MAC address

setting	the NMSettingWireless
bssid	the new BSSID to add to the list

setting	the NMSettingWireless
i	index of a BSSID in the previously seen BSSID list

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

NM_SETTING_WIRELESS_WAKE_ON_WLAN_NONE	- Wake-on-WLAN disabled -
NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY	- Wake on any activity -
NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT	- Wake on disconnect -
NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC	- Wake on magic packet -
NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE	- Wake on GTK rekey failure -
NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST	- Wake on EAP identity request -
NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE	- Wake on 4way handshake -
NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE	- Wake on rfkill release -
NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP
NM_SETTING_WIRELESS_WAKE_ON_WLAN_ALL	- Wake on all events. This does not -include the exclusive flags `NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT` - or -`NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE` -. -
NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT	- Use the default value -
NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE	- Don't change configured settings -
NM_SETTING_WIRELESS_WAKE_ON_WLAN_EXCLUSIVE_FLAGS	- Mask of flags that are -incompatible with other flags -

NM_SETTING_WIRELESS_POWERSAVE_DEFAULT	- use the default value -
NM_SETTING_WIRELESS_POWERSAVE_IGNORE	- don't touch existing setting -
NM_SETTING_WIRELESS_POWERSAVE_DISABLE	- disable powersave -
NM_SETTING_WIRELESS_POWERSAVE_ENABLE	- enable powersave -
_NM_SETTING_WIRELESS_POWERSAVE_NUM
NM_SETTING_WIRELESS_POWERSAVE_LAST