NMDeviceWifi

@@ -41,659 +32,762 @@

NMDeviceWifi

- +

Synopsis

enum                NMDeviceWifiError;
-#define             NM_DEVICE_WIFI_ERROR
-GQuark              nm_device_wifi_error_quark          (void);
-#define             NM_DEVICE_WIFI_HW_ADDRESS
-#define             NM_DEVICE_WIFI_PERMANENT_HW_ADDRESS
-#define             NM_DEVICE_WIFI_MODE
-#define             NM_DEVICE_WIFI_BITRATE
-#define             NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT
-#define             NM_DEVICE_WIFI_CAPABILITIES
-                    NMDeviceWifi;
-                    NMDeviceWifiClass;
-GObject *           nm_device_wifi_new                  (DBusGConnection *connection,
-                                                         const char *path);
-const char *        nm_device_wifi_get_hw_address       (NMDeviceWifi *device);
-const char *        nm_device_wifi_get_permanent_hw_address
-                                                        (NMDeviceWifi *device);
-NM80211Mode         nm_device_wifi_get_mode             (NMDeviceWifi *device);
-guint32             nm_device_wifi_get_bitrate          (NMDeviceWifi *device);
-NMDeviceWifiCapabilities nm_device_wifi_get_capabilities
-                                                        (NMDeviceWifi *device);
-NMAccessPoint *     nm_device_wifi_get_active_access_point
-                                                        (NMDeviceWifi *device);
-NMAccessPoint *     nm_device_wifi_get_access_point_by_path
-                                                        (NMDeviceWifi *device,
-                                                         const char *path);
-const GPtrArray *   nm_device_wifi_get_access_points    (NMDeviceWifi *device);
-void                (*NMDeviceWifiRequestScanFn)        (NMDeviceWifi *device,
-                                                         GError *error,
-                                                         gpointer user_data);
-void                nm_device_wifi_request_scan_simple  (NMDeviceWifi *device,
-                                                         NMDeviceWifiRequestScanFn callback,
-                                                         gpointer user_data);
-

Object Hierarchy

-  GObject
-   +----NMObject
-         +----NMDevice
-               +----NMDeviceWifi
-

Implemented Interfaces

-NMDeviceWifi implements - GInitable and GAsyncInitable.

Properties

-  "active-access-point"      NMAccessPoint*        : Read
-  "bitrate"                  guint                 : Read
-  "hw-address"               gchar*                : Read
-  "mode"                     guint                 : Read
-  "perm-hw-address"          gchar*                : Read
-  "wireless-capabilities"    guint                 : Read
-

Signals

-  "access-point-added"                             : Run First
-  "access-point-removed"                           : Run First
-

Description

Details

enum NMDeviceWifiError

typedef enum {
-	NM_DEVICE_WIFI_ERROR_UNKNOWN = 0,             /*< nick=UnknownError >*/
-	NM_DEVICE_WIFI_ERROR_NOT_WIFI_CONNECTION,     /*< nick=NotWifiConnection >*/
-	NM_DEVICE_WIFI_ERROR_INVALID_WIFI_CONNECTION, /*< nick=InvalidWifiConnection >*/
-	NM_DEVICE_WIFI_ERROR_INVALID_DEVICE_MAC,      /*< nick=InvalidDeviceMac >*/
-	NM_DEVICE_WIFI_ERROR_MAC_MISMATCH,            /*< nick=MacMismatch >*/
-	NM_DEVICE_WIFI_ERROR_MISSING_DEVICE_WPA_CAPS, /*< nick=MissingDeviceWpaCaps >*/
-	NM_DEVICE_WIFI_ERROR_MISSING_DEVICE_RSN_CAPS, /*< nick=MissingDeviceRsnCaps >*/
-} NMDeviceWifiError;
-

Functions

--++ - - + + + + + + + + + + + + + + + + + + + + + - - + - - + - - + - - + - - + - - +

`NM_DEVICE_WIFI_ERROR_UNKNOWN`	unknown or unclassified error +	+GQuark +	+nm_device_wifi_error_quark () +
+GObject * +	+nm_device_wifi_new () +
const char * +	+nm_device_wifi_get_hw_address () +
const char * +	+nm_device_wifi_get_permanent_hw_address () +
+NM80211Mode +	+nm_device_wifi_get_mode () +
+guint32 +	+nm_device_wifi_get_bitrate ()
`NM_DEVICE_WIFI_ERROR_NOT_WIFI_CONNECTION`	the connection was not of Wi-Fi type +	+NMDeviceWifiCapabilities +	+nm_device_wifi_get_capabilities ()
`NM_DEVICE_WIFI_ERROR_INVALID_WIFI_CONNECTION`	the Wi-Fi connection was invalid +	+NMAccessPoint * +	+nm_device_wifi_get_active_access_point ()
`NM_DEVICE_WIFI_ERROR_INVALID_DEVICE_MAC`	the device's MAC was invalid +	+NMAccessPoint * +	+nm_device_wifi_get_access_point_by_path ()
`NM_DEVICE_WIFI_ERROR_MAC_MISMATCH`	the MACs of the connection and the device mismatched +	const GPtrArray * +	+nm_device_wifi_get_access_points ()
`NM_DEVICE_WIFI_ERROR_MISSING_DEVICE_WPA_CAPS`	the device missed WPA capabilities -required by the connection +	+void +	+(*NMDeviceWifiRequestScanFn) ()
`NM_DEVICE_WIFI_ERROR_MISSING_DEVICE_RSN_CAPS`	the device missed RSN capabilities -required by the connection +	+void +	+nm_device_wifi_request_scan_simple ()

NM_DEVICE_WIFI_ERROR

#define NM_DEVICE_WIFI_ERROR nm_device_wifi_error_quark ()
-

Properties

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

+NMAccessPoint *	active-access-point	Read
guint	bitrate	Read
+gchar *	hw-address	Read
guint	mode	Read
+gchar *	perm-hw-address	Read
guint	wireless-capabilities	Read

nm_device_wifi_error_quark ()

GQuark              nm_device_wifi_error_quark          (void);

-Registers an error quark for NMDeviceWifi if necessary. -

Signals

--+++ - - - - + + + + + + + + + + + +

Returns :	the error quark used for NMDeviceWifi errors.
void	access-point-added	Run First
void	access-point-removed	Run First

NM_DEVICE_WIFI_HW_ADDRESS

#define NM_DEVICE_WIFI_HW_ADDRESS          "hw-address"
-

Types and Values

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

enum	NMDeviceWifiError
#define	NM_DEVICE_WIFI_ERROR
#define	NM_DEVICE_WIFI_HW_ADDRESS
#define	NM_DEVICE_WIFI_PERMANENT_HW_ADDRESS
#define	NM_DEVICE_WIFI_MODE
#define	NM_DEVICE_WIFI_BITRATE
#define	NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT
#define	NM_DEVICE_WIFI_CAPABILITIES

NM_DEVICE_WIFI_PERMANENT_HW_ADDRESS

#define NM_DEVICE_WIFI_PERMANENT_HW_ADDRESS "perm-hw-address"
+
+Object Hierarchy
+    GObject
+    ╰── NMObject
+        ╰── NMDevice
+            ╰── NMDeviceWifi
 
-
-
 
-
-
-NM_DEVICE_WIFI_MODE
-#define NM_DEVICE_WIFI_MODE                "mode"
-
+
+Description
 
 
 
-
+
+Functions
 
-NM_DEVICE_WIFI_BITRATE
-#define NM_DEVICE_WIFI_BITRATE             "bitrate"
-
-
-
+nm_device_wifi_error_quark ()
+GQuark
+nm_device_wifi_error_quark (void);
+Registers an error quark for NMDeviceWifi if necessary.
+
+Returns
+ the error quark used for NMDeviceWifi errors.
+
+
 
 
 
-NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT
-#define NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT "active-access-point"
-
-
-
+nm_device_wifi_new ()
+GObject *
+nm_device_wifi_new (DBusGConnection *connection,
+                    const char *path);
+Creates a new NMDeviceWifi.
+
+Parameters
+
+++++
+
+
+
+
+
+
+
+
+
+
+
+
+



connection the DBusGConnection  
path the DBus object path of the device  
+
+
+Returns
+ a new WiFi device. 
+[transfer full]
+
 
 
 
-NM_DEVICE_WIFI_CAPABILITIES
-#define NM_DEVICE_WIFI_CAPABILITIES        "wireless-capabilities"
-
-
-
+nm_device_wifi_get_hw_address ()
+const char *
+nm_device_wifi_get_hw_address (NMDeviceWifi *device);
+Gets the actual hardware (MAC) address of the NMDeviceWifi
+
+Parameters
+
+++++
+
+
+
+
+
+



device a NMDeviceWifi  
+
+
+Returns
+ the actual hardware address. This is the internal string used by the
+device, and must not be modified.
+
+
 
 
 
-NMDeviceWifi
-typedef struct _NMDeviceWifi NMDeviceWifi;
-
-
+nm_device_wifi_get_permanent_hw_address ()
+const char *
+nm_device_wifi_get_permanent_hw_address
+                               (NMDeviceWifi *device);
+Gets the permanent hardware (MAC) address of the NMDeviceWifi
+
+Parameters
+
+++++
+
+
+
+
+
+



device a NMDeviceWifi  
+
+
+Returns
+ the permanent hardware address. This is the internal string used by the
+device, and must not be modified.
+
+
 
 
 
-NMDeviceWifiClass
-typedef struct {
-	NMDeviceClass parent;
-
-	/* Signals */
-	void (*access_point_added) (NMDeviceWifi *device, NMAccessPoint *ap);
-	void (*access_point_removed) (NMDeviceWifi *device, NMAccessPoint *ap);
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-} NMDeviceWifiClass;
-
-
-
+nm_device_wifi_get_mode ()
+NM80211Mode
+nm_device_wifi_get_mode (NMDeviceWifi *device);
+Gets the NMDeviceWifi mode.
+
+Parameters
+
+++++
+
+
+
+
+
+



device a NMDeviceWifi  
+
+
+Returns
+ the mode
+
+
 
 
 
-nm_device_wifi_new ()
-GObject *           nm_device_wifi_new                  (DBusGConnection *connection,
-                                                         const char *path);
-
-Creates a new NMDeviceWifi.
-
-
+nm_device_wifi_get_bitrate ()
+guint32
+nm_device_wifi_get_bitrate (NMDeviceWifi *device);
+Gets the bit rate of the NMDeviceWifi.
+
+Parameters
+
--+++
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
 





 connection : the DBusGConnection
-
path : the DBus object path of the device
Returns : a new WiFi device. [transfer full]
-
device a NMDeviceWifi  
 
 
+
+Returns
+ the bit rate
+
+
+
 
 
-nm_device_wifi_get_hw_address ()
-const char *        nm_device_wifi_get_hw_address       (NMDeviceWifi *device);
-
-Gets the actual hardware (MAC) address of the NMDeviceWifi
-
-
+nm_device_wifi_get_capabilities ()
+NMDeviceWifiCapabilities
+nm_device_wifi_get_capabilities (NMDeviceWifi *device);
+Gets the WIFI capabilities of the NMDeviceWifi.
+
+Parameters
+
--+++
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
 





 device : a NMDeviceWifi
-
Returns : the actual hardware address. This is the internal string used by the
-device, and must not be modified.
device a NMDeviceWifi  
 
 
+
+Returns
+ the capabilities
+
+
+
 
 
-nm_device_wifi_get_permanent_hw_address ()
-const char *        nm_device_wifi_get_permanent_hw_address
-                                                        (NMDeviceWifi *device);
-
-Gets the permanent hardware (MAC) address of the NMDeviceWifi
-
-
+nm_device_wifi_get_active_access_point ()
+NMAccessPoint *
+nm_device_wifi_get_active_access_point
+                               (NMDeviceWifi *device);
+Gets the active NMAccessPoint.
+
+Parameters
+
--+++
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
 





 device : a NMDeviceWifi
-
Returns : the permanent hardware address. This is the internal string used by the
-device, and must not be modified.
device a NMDeviceWifi  
 
 
+
+Returns
+ the access point or NULL if none is active. 
+[transfer none]
+
+

nm_device_wifi_get_mode ()

NM80211Mode         nm_device_wifi_get_mode             (NMDeviceWifi *device);

-Gets the NMDeviceWifi mode. -

nm_device_wifi_get_access_point_by_path ()

NMAccessPoint *
+nm_device_wifi_get_access_point_by_path
+                               (NMDeviceWifi *device,
+                                const char *path);

Gets a NMAccessPoint by path.

Parameters

--+++ - - + + + - - + + +

`device` :	a NMDeviceWifi -	device	a NMDeviceWifi
Returns :	the mode	path	the object path of the access point

Returns

the access point or NULL if none is found.

[transfer none]

nm_device_wifi_get_bitrate ()

guint32             nm_device_wifi_get_bitrate          (NMDeviceWifi *device);

-Gets the bit rate of the NMDeviceWifi. -

nm_device_wifi_get_access_points ()

const GPtrArray *
+nm_device_wifi_get_access_points (NMDeviceWifi *device);

Gets all the scanned access points of the NMDeviceWifi.

Parameters

--+++ - - - - - - - - - - + + + + +

`device` :	a NMDeviceWifi -
Returns :	the bit rate
device	a NMDeviceWifi

Returns

a GPtrArray containing all the +scanned NMAccessPoints. +The returned array is owned by the client and should not be modified.

[element-type NMClient.AccessPoint]

nm_device_wifi_get_capabilities ()

NMDeviceWifiCapabilities nm_device_wifi_get_capabilities
-                                                        (NMDeviceWifi *device);

NMDeviceWifiRequestScanFn ()

void
+(*NMDeviceWifiRequestScanFn) (NMDeviceWifi *device,
+                              GError *error,
+                              gpointer user_data);

-Gets the WIFI capabilities of the NMDeviceWifi.

+ +

nm_device_wifi_request_scan_simple ()

void
+nm_device_wifi_request_scan_simple (NMDeviceWifi *device,
+                                    NMDeviceWifiRequestScanFn callback,
+                                    gpointer user_data);

Request NM to scan for access points on the NMDeviceWifi. This function only +instructs NM to perform scanning. Use nm_device_wifi_get_access_points() +to get available access points.

Parameters

--+++ - - + + + - - + + + + + + + +

`device` :	a NMDeviceWifi -	device	a NMDeviceWifi
Returns :	the capabilities	callback	the function to call when the call is done.	[scope async][allow-none]
user_data	user data to pass to the callback function.	[closure]

Since 0.9.8

`device` :	a NMDeviceWifi -
`callback` :	the function to call when the call is done. [scope async][allow-none] -
`user_data` :	user data to pass to the callback function. [closure] -

`device` :	the wifi device that received the signal
`ap` :	the new access point
`user_data` :	user data set when the signal handler was connected.

`device` :	the wifi device that received the signal
`ap` :	the removed access point
`user_data` :	user data set when the signal handler was connected.

			libnm-glib Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Implemented Interfaces - \| - Properties - \| - Signals -

connection	the DBusGConnection
path	the DBus object path of the device

`connection` :	the DBusGConnection -
`path` :	the DBus object path of the device
Returns :	a new WiFi device. [transfer full] -
device	a NMDeviceWifi

`device` :	a NMDeviceWifi +	NM_DEVICE_WIFI_ERROR_UNKNOWN	+ unknown or unclassified error
Returns :	the access point or `NULL` if none is active. [transfer none] +	NM_DEVICE_WIFI_ERROR_NOT_WIFI_CONNECTION	+ the connection was not of Wi-Fi type

`device` :	a NMDeviceWifi +	NM_DEVICE_WIFI_ERROR_INVALID_WIFI_CONNECTION	+ the Wi-Fi connection was invalid
`path` :	the object path of the access point	NM_DEVICE_WIFI_ERROR_INVALID_DEVICE_MAC	+ the device's MAC was invalid +
Returns :	the access point or `NULL` if none is found. [transfer none] +	NM_DEVICE_WIFI_ERROR_MAC_MISMATCH	+ the MACs of the connection and the device mismatched

`device` :	a NMDeviceWifi +	NM_DEVICE_WIFI_ERROR_MISSING_DEVICE_WPA_CAPS	+ the device missed WPA capabilities +required by the connection
Returns :	a GPtrArray containing all the -scanned NMAccessPoints. -The returned array is owned by the client and should not be modified. [element-type NMClient.AccessPoint] +	NM_DEVICE_WIFI_ERROR_MISSING_DEVICE_RSN_CAPS	+ the device missed RSN capabilities +required by the connection

NMDeviceWifi

Synopsis

Object Hierarchy

Implemented Interfaces

Properties

Signals

Description

Details

enum NMDeviceWifiError

Functions

NM_DEVICE_WIFI_ERROR

Properties

nm_device_wifi_error_quark ()

Signals

NM_DEVICE_WIFI_HW_ADDRESS

Types and Values

NM_DEVICE_WIFI_PERMANENT_HW_ADDRESS

Object Hierarchy

NM_DEVICE_WIFI_MODE

Description

Functions

NM_DEVICE_WIFI_BITRATE

nm_device_wifi_error_quark ()

Returns

NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT

nm_device_wifi_new ()

Parameters

Returns

NM_DEVICE_WIFI_CAPABILITIES

nm_device_wifi_get_hw_address ()

Parameters

Returns

NMDeviceWifi

nm_device_wifi_get_permanent_hw_address ()

Parameters

Returns

NMDeviceWifiClass

nm_device_wifi_get_mode ()

Parameters

Returns

nm_device_wifi_new ()

nm_device_wifi_get_bitrate ()

Parameters

Returns

nm_device_wifi_get_hw_address ()

nm_device_wifi_get_capabilities ()

Parameters

Returns

nm_device_wifi_get_permanent_hw_address ()

nm_device_wifi_get_active_access_point ()

Parameters

Returns

nm_device_wifi_get_mode ()

nm_device_wifi_get_access_point_by_path ()

Parameters

Returns

nm_device_wifi_get_bitrate ()

nm_device_wifi_get_access_points ()

Parameters

Returns

nm_device_wifi_get_capabilities ()

NMDeviceWifiRequestScanFn ()

nm_device_wifi_request_scan_simple ()

Parameters

Types and Values

nm_device_wifi_get_active_access_point ()

enum NMDeviceWifiError

Members

nm_device_wifi_get_access_point_by_path ()

nm_device_wifi_get_access_points ()

NMDeviceWifiRequestScanFn ()

NM_DEVICE_WIFI_ERROR

nm_device_wifi_request_scan_simple ()

NM_DEVICE_WIFI_HW_ADDRESS

NM_DEVICE_WIFI_PERMANENT_HW_ADDRESS

Property Details

The "active-access-point" property

NM_DEVICE_WIFI_MODE

The "bitrate" property

NM_DEVICE_WIFI_BITRATE

The `"active-access-point"` property

The `"bitrate"` property

The `"hw-address"` property

The `"mode"` property

The `“active-access-point”` property

The `“bitrate”` property

The `“hw-address”` property

The `“mode”` property

The `"perm-hw-address"` property

The `“perm-hw-address”` property

The `"wireless-capabilities"` property

The `“wireless-capabilities”` property

The `"access-point-added"` signal

The `“access-point-added”` signal

The `"access-point-removed"` signal

The `“access-point-removed”` signal