From 9fae01fa351805b2903e535736e06971bc0b925e Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Mon, 29 Nov 2010 00:47:11 +0100 Subject: Imported Upstream version 0.8.1 --- docs/libnm-util/html/NMSettingWireless.html | 797 ++++++++++++++++++++++++++++ 1 file changed, 797 insertions(+) create mode 100644 docs/libnm-util/html/NMSettingWireless.html (limited to 'docs/libnm-util/html/NMSettingWireless.html') diff --git a/docs/libnm-util/html/NMSettingWireless.html b/docs/libnm-util/html/NMSettingWireless.html new file mode 100644 index 00000000..d03c4b72 --- /dev/null +++ b/docs/libnm-util/html/NMSettingWireless.html @@ -0,0 +1,797 @@ + + + + +NMSettingWireless + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingWireless

+

NMSettingWireless

+
+
+

Synopsis

+
#define             NM_SETTING_WIRELESS_SETTING_NAME
+enum                NMSettingWirelessError;
+#define             NM_TYPE_SETTING_WIRELESS_ERROR
+#define             NM_SETTING_WIRELESS_ERROR
+GQuark              nm_setting_wireless_error_quark     (void);
+#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_MTU
+#define             NM_SETTING_WIRELESS_SEEN_BSSIDS
+#define             NM_SETTING_WIRELESS_SEC
+                    NMSettingWireless;
+                    NMSettingWirelessClass;
+GType               nm_setting_wireless_get_type        (void);
+NMSetting *         nm_setting_wireless_new             (void);
+const GByteArray *  nm_setting_wireless_get_ssid        (NMSettingWireless *setting);
+const char *        nm_setting_wireless_get_mode        (NMSettingWireless *setting);
+const char *        nm_setting_wireless_get_band        (NMSettingWireless *setting);
+guint32             nm_setting_wireless_get_channel     (NMSettingWireless *setting);
+const GByteArray *  nm_setting_wireless_get_bssid       (NMSettingWireless *setting);
+guint32             nm_setting_wireless_get_rate        (NMSettingWireless *setting);
+guint32             nm_setting_wireless_get_tx_power    (NMSettingWireless *setting);
+const GByteArray *  nm_setting_wireless_get_mac_address (NMSettingWireless *setting);
+guint32             nm_setting_wireless_get_mtu         (NMSettingWireless *setting);
+const char *        nm_setting_wireless_get_security    (NMSettingWireless *setting);
+gboolean            nm_setting_wireless_add_seen_bssid  (NMSettingWireless *setting,
+                                                         const char *bssid);
+guint32             nm_setting_wireless_get_num_seen_bssids
+                                                        (NMSettingWireless *setting);
+const char *        nm_setting_wireless_get_seen_bssid  (NMSettingWireless *setting,
+                                                         guint32 i);
+gboolean            nm_setting_wireless_ap_security_compatible
+                                                        (NMSettingWireless *s_wireless,
+                                                         NMSettingWirelessSecurity *s_wireless_sec,
+                                                         guint32 ap_flags,
+                                                         guint32 ap_wpa,
+                                                         guint32 ap_rsn,
+                                                         guint32 ap_mode);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSetting
+         +----NMSettingWireless
+
+
+
+

Properties

+
+  "band"                     gchar*                : Read / Write
+  "bssid"                    GArray_guchar_*       : Read / Write
+  "channel"                  guint                 : Read / Write / Construct
+  "mac-address"              GArray_guchar_*       : Read / Write
+  "mode"                     gchar*                : Read / Write
+  "mtu"                      guint                 : Read / Write / Construct
+  "rate"                     guint                 : Read / Write / Construct
+  "security"                 gchar*                : Read / Write
+  "seen-bssids"              GSList_gchararray_*   : Read / Write
+  "ssid"                     GArray_guchar_*       : Read / Write
+  "tx-power"                 guint                 : Read / Write / Construct
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_SETTING_WIRELESS_SETTING_NAME

+
#define NM_SETTING_WIRELESS_SETTING_NAME "802-11-wireless"
+
+

+

+
+
+
+

enum NMSettingWirelessError

+
typedef enum
+{
+	NM_SETTING_WIRELESS_ERROR_UNKNOWN = 0,
+	NM_SETTING_WIRELESS_ERROR_INVALID_PROPERTY,
+	NM_SETTING_WIRELESS_ERROR_MISSING_PROPERTY,
+	NM_SETTING_WIRELESS_ERROR_MISSING_SECURITY_SETTING,
+	NM_SETTING_WIRELESS_ERROR_CHANNEL_REQUIRES_BAND
+} NMSettingWirelessError;
+
+

+

+
+
+
+

NM_TYPE_SETTING_WIRELESS_ERROR

+
#define NM_TYPE_SETTING_WIRELESS_ERROR (nm_setting_wireless_error_get_type ()) 
+
+

+

+
+
+
+

NM_SETTING_WIRELESS_ERROR

+
#define NM_SETTING_WIRELESS_ERROR nm_setting_wireless_error_quark ()
+
+

+

+
+
+
+

nm_setting_wireless_error_quark ()

+
GQuark              nm_setting_wireless_error_quark     (void);
+

+

+
++ + + + +

Returns :

 +
+
+
+
+

NM_SETTING_WIRELESS_SSID

+
#define NM_SETTING_WIRELESS_SSID        "ssid"
+
+

+

+
+
+
+

NM_SETTING_WIRELESS_MODE

+
#define NM_SETTING_WIRELESS_MODE        "mode"
+
+

+

+
+
+
+

NM_SETTING_WIRELESS_BAND

+
#define NM_SETTING_WIRELESS_BAND        "band"
+
+

+

+
+
+
+

NM_SETTING_WIRELESS_CHANNEL

+
#define NM_SETTING_WIRELESS_CHANNEL     "channel"
+
+

+

+
+
+
+

NM_SETTING_WIRELESS_BSSID

+
#define NM_SETTING_WIRELESS_BSSID       "bssid"
+
+

+

+
+
+
+

NM_SETTING_WIRELESS_RATE

+
#define NM_SETTING_WIRELESS_RATE        "rate"
+
+

+

+
+
+
+

NM_SETTING_WIRELESS_TX_POWER

+
#define NM_SETTING_WIRELESS_TX_POWER    "tx-power"
+
+

+

+
+
+
+

NM_SETTING_WIRELESS_MAC_ADDRESS

+
#define NM_SETTING_WIRELESS_MAC_ADDRESS "mac-address"
+
+

+

+
+
+
+

NM_SETTING_WIRELESS_MTU

+
#define NM_SETTING_WIRELESS_MTU         "mtu"
+
+

+

+
+
+
+

NM_SETTING_WIRELESS_SEEN_BSSIDS

+
#define NM_SETTING_WIRELESS_SEEN_BSSIDS "seen-bssids"
+
+

+

+
+
+
+

NM_SETTING_WIRELESS_SEC

+
#define NM_SETTING_WIRELESS_SEC         "security"
+
+

+

+
+
+
+

NMSettingWireless

+
typedef struct _NMSettingWireless NMSettingWireless;
+

+

+
+
+
+

NMSettingWirelessClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingWirelessClass;
+
+

+

+
+
+
+

nm_setting_wireless_get_type ()

+
GType               nm_setting_wireless_get_type        (void);
+

+

+
++ + + + +

Returns :

 +
+
+
+
+

nm_setting_wireless_new ()

+
NMSetting *         nm_setting_wireless_new             (void);
+

+

+
++ + + + +

Returns :

 +
+
+
+
+

nm_setting_wireless_get_ssid ()

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

+

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

setting :

 +

Returns :

 +
+
+
+
+

nm_setting_wireless_get_mode ()

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

+

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

setting :

 +

Returns :

 +
+
+
+
+

nm_setting_wireless_get_band ()

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

+

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

setting :

 +

Returns :

 +
+
+
+
+

nm_setting_wireless_get_channel ()

+
guint32             nm_setting_wireless_get_channel     (NMSettingWireless *setting);
+

+

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

setting :

 +

Returns :

 +
+
+
+
+

nm_setting_wireless_get_bssid ()

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

+

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

setting :

 +

Returns :

 +
+
+
+
+

nm_setting_wireless_get_rate ()

+
guint32             nm_setting_wireless_get_rate        (NMSettingWireless *setting);
+

+

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

setting :

 +

Returns :

 +
+
+
+
+

nm_setting_wireless_get_tx_power ()

+
guint32             nm_setting_wireless_get_tx_power    (NMSettingWireless *setting);
+

+

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

setting :

 +

Returns :

 +
+
+
+
+

nm_setting_wireless_get_mac_address ()

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

+

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

setting :

 +

Returns :

 +
+
+
+
+

nm_setting_wireless_get_mtu ()

+
guint32             nm_setting_wireless_get_mtu         (NMSettingWireless *setting);
+

+

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

setting :

 +

Returns :

 +
+
+
+
+

nm_setting_wireless_get_security ()

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

+

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

setting :

 +

Returns :

 +
+
+
+
+

nm_setting_wireless_add_seen_bssid ()

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

+

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

setting :

 +

bssid :

 +

Returns :

 +
+
+
+
+

nm_setting_wireless_get_num_seen_bssids ()

+
guint32             nm_setting_wireless_get_num_seen_bssids
+                                                        (NMSettingWireless *setting);
+

+

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

setting :

 +

Returns :

 +
+
+
+
+

nm_setting_wireless_get_seen_bssid ()

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

+

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

setting :

 +

i :

 +

Returns :

 +
+
+
+
+

nm_setting_wireless_ap_security_compatible ()

+
gboolean            nm_setting_wireless_ap_security_compatible
+                                                        (NMSettingWireless *s_wireless,
+                                                         NMSettingWirelessSecurity *s_wireless_sec,
+                                                         guint32 ap_flags,
+                                                         guint32 ap_wpa,
+                                                         guint32 ap_rsn,
+                                                         guint32 ap_mode);
+

+

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

s_wireless :

 +

s_wireless_sec :

 +

ap_flags :

 +

ap_wpa :

 +

ap_rsn :

 +

ap_mode :

 +

Returns :

 +
+
+
+
+

Property Details

+
+

The "band" property

+
  "band"                     gchar*                : Read / Write
+

+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 WiFi network +to the specific band, i.e. if 'a' is specified, the device will not +associate with the same network in the 2.4GHz band even if the network's +settings are compatible. This setting depends on specific driver +capability and may not work with all drivers. +

+

Default value: NULL

+
+
+
+

The "bssid" property

+
  "bssid"                    GArray_guchar_*       : Read / Write
+

+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 +creating an Ad-Hoc network and is unlikely to in the future. +

+
+
+
+

The "channel" property

+
  "channel"                  guint                 : Read / Write / Construct
+

+Wireless channel to use for the WiFi connection. The device will only +join (or create for Ad-Hoc networks) a WiFi network on the specified +channel. Because channel numbers overlap between bands, this property +also requires the 'band' property to be set. +

+

Default value: 0

+
+
+
+

The "mac-address" property

+
  "mac-address"              GArray_guchar_*       : Read / Write
+

+If specified, this connection will only apply to the WiFi device +whose MAC address matches. This property does not change the MAC address +of the device (known as MAC spoofing). +

+
+
+
+

The "mode" property

+
  "mode"                     gchar*                : Read / Write
+

+WiFi network mode; one of 'infrastructure' or 'adhoc'. If blank, +infrastructure is assumed. +

+

Default value: NULL

+
+
+
+

The "mtu" property

+
  "mtu"                      guint                 : Read / Write / Construct
+

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

+

Default value: 0

+
+
+
+

The "rate" property

+
  "rate"                     guint                 : Read / Write / Construct
+

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

+

Default value: 0

+
+
+
+

The "security" property

+
  "security"                 gchar*                : Read / Write
+

+If the wireless connection has any security restrictions, like 802.1x, +WEP, or WPA, set this property to '802-11-wireless-security' and ensure +the connection contains a valid 802-11-wireless-security setting. +

+

Default value: NULL

+
+
+
+

The "seen-bssids" property

+
  "seen-bssids"              GSList_gchararray_*   : Read / Write
+

+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 WiFI network. +The settings service will usually populate this property by periodically +asking NetworkManager what the device's current AP is while connected +to the network (or monitoring the device's 'active-ap' property) and +adding the current AP'sBSSID to this list. This list helps NetworkManager +find hidden APs by matching up scan results with the BSSIDs in this list. +

+
+
+
+

The "ssid" property

+
  "ssid"                     GArray_guchar_*       : Read / Write
+

+SSID of the WiFi network. +

+
+
+
+

The "tx-power" property

+
  "tx-power"                 guint                 : Read / Write / Construct
+

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

+

Default value: 0

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