NMDeviceWifi: libnm-glib Reference Manual

Functions

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 ()
NMDeviceWifiCapabilities	nm_device_wifi_get_capabilities ()
NMAccessPoint *	nm_device_wifi_get_active_access_point ()
NMAccessPoint *	nm_device_wifi_get_access_point_by_path ()
const GPtrArray *	nm_device_wifi_get_access_points ()
void	(*NMDeviceWifiRequestScanFn) ()
void	nm_device_wifi_request_scan_simple ()

Properties

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

Signals

void	access-point-added	Run First
void	access-point-removed	Run First

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
#define	NM_DEVICE_WIFI_ACCESS_POINTS

Object Hierarchy

    GObject
    ╰── NMObject
        ╰── NMDevice
            ╰── NMDeviceWifi

Description

Functions

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_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 Wi-Fi device.

[transfer full]

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.

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.

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

guint32
nm_device_wifi_get_bitrate (NMDeviceWifi *device);

Gets the bit rate of the NMDeviceWifi in kbit/s.

Parameters

device

a NMDeviceWifi

Returns

the bit rate (kbit/s)

nm_device_wifi_get_capabilities ()

NMDeviceWifiCapabilities
nm_device_wifi_get_capabilities (NMDeviceWifi *device);

Gets the Wi-Fi capabilities of the NMDeviceWifi.

Parameters

device

a NMDeviceWifi

Returns

the capabilities

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 access point or NULL if none is active.

[transfer none]

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
path	the object path of the access point

Returns

the access point or NULL if none is found.

[transfer none]

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

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

[element-type NMAccessPoint]

NMDeviceWifiRequestScanFn ()

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

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

Types and Values

enum NMDeviceWifiError

Members

NM_DEVICE_WIFI_ERROR_UNKNOWN	unknown or unclassified error
NM_DEVICE_WIFI_ERROR_NOT_WIFI_CONNECTION	the connection was not of Wi-Fi type
NM_DEVICE_WIFI_ERROR_INVALID_WIFI_CONNECTION	the Wi-Fi connection was invalid
NM_DEVICE_WIFI_ERROR_INVALID_DEVICE_MAC	the device's MAC was invalid
NM_DEVICE_WIFI_ERROR_MAC_MISMATCH	the MACs of the connection and the device mismatched
NM_DEVICE_WIFI_ERROR_MISSING_DEVICE_WPA_CAPS	the device missed WPA capabilities required by the connection
NM_DEVICE_WIFI_ERROR_MISSING_DEVICE_RSN_CAPS	the device missed RSN capabilities required by the connection

NM_DEVICE_WIFI_ERROR

#define NM_DEVICE_WIFI_ERROR nm_device_wifi_error_quark ()

NM_DEVICE_WIFI_HW_ADDRESS

#define NM_DEVICE_WIFI_HW_ADDRESS          "hw-address"

NM_DEVICE_WIFI_PERMANENT_HW_ADDRESS

#define NM_DEVICE_WIFI_PERMANENT_HW_ADDRESS "perm-hw-address"

NM_DEVICE_WIFI_MODE

#define NM_DEVICE_WIFI_MODE                "mode"

NM_DEVICE_WIFI_BITRATE

#define NM_DEVICE_WIFI_BITRATE             "bitrate"

NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT

#define NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT "active-access-point"

NM_DEVICE_WIFI_CAPABILITIES

#define NM_DEVICE_WIFI_CAPABILITIES        "wireless-capabilities"

NM_DEVICE_WIFI_ACCESS_POINTS

#define NM_DEVICE_WIFI_ACCESS_POINTS       "access-points"

Property Details

The `“access-points”` property

  “access-points”            NMObjectArray *

List of all Wi-Fi access points the device can see.

Flags: Read

Since: 0.9.10

The `“active-access-point”` property

  “active-access-point”      NMAccessPoint *

The active NMAccessPoint of the device.

Flags: Read

The `“bitrate”` property

  “bitrate”                  guint

The bit rate of the device in kbit/s.

Flags: Read

Default value: 0

The `“hw-address”` property

  “hw-address”               gchar *

The hardware (MAC) address of the device.

Flags: Read

Default value: NULL

The `“mode”` property

  “mode”                     guint

The mode of the device.

Flags: Read

Allowed values: <= 3

Default value: 2

The `“perm-hw-address”` property

  “perm-hw-address”          gchar *

The hardware (MAC) address of the device.

Flags: Read

Default value: NULL

The `“wireless-capabilities”` property

  “wireless-capabilities”    guint

The wireless capabilities of the device.

Flags: Read

Default value: 0

Signal Details

The `“access-point-added”` signal

void
user_function (NMDeviceWifi *device,
               GObject      *ap,
               gpointer      user_data)

Notifies that a NMAccessPoint is added to the Wi-Fi device.

Parameters

device	the Wi-Fi device that received the signal
ap	the new access point
user_data	user data set when the signal handler was connected.

Flags: Run First

The `“access-point-removed”` signal

void
user_function (NMDeviceWifi *device,
               GObject      *ap,
               gpointer      user_data)

Notifies that a NMAccessPoint is removed from the Wi-Fi device.

Parameters

device	the Wi-Fi device that received the signal
ap	the removed access point
user_data	user data set when the signal handler was connected.

Flags: Run First

NMDeviceWifi

Functions

Properties

Signals

Types and Values

Object Hierarchy

Description

Functions

nm_device_wifi_error_quark ()

Returns

nm_device_wifi_new ()

Parameters

Returns

nm_device_wifi_get_hw_address ()

Parameters

Returns

nm_device_wifi_get_permanent_hw_address ()

Parameters

Returns

nm_device_wifi_get_mode ()

Parameters

Returns

nm_device_wifi_get_bitrate ()

Parameters

Returns

nm_device_wifi_get_capabilities ()

Parameters

Returns

nm_device_wifi_get_active_access_point ()

Parameters

Returns

nm_device_wifi_get_access_point_by_path ()

Parameters

Returns

nm_device_wifi_get_access_points ()

Parameters

Returns

NMDeviceWifiRequestScanFn ()

nm_device_wifi_request_scan_simple ()

Parameters

Types and Values

enum NMDeviceWifiError

Members

NM_DEVICE_WIFI_ERROR

NM_DEVICE_WIFI_HW_ADDRESS

NM_DEVICE_WIFI_PERMANENT_HW_ADDRESS

NM_DEVICE_WIFI_MODE

NM_DEVICE_WIFI_BITRATE

NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT

NM_DEVICE_WIFI_CAPABILITIES

NM_DEVICE_WIFI_ACCESS_POINTS

Property Details

The “access-points” property

The “active-access-point” property

The “bitrate” property

The “hw-address” property

The “mode” property

The “perm-hw-address” property

The “wireless-capabilities” property

Signal Details

The “access-point-added” signal

Parameters

The “access-point-removed” signal

Parameters

The `“access-points”` property

The `“active-access-point”` property

The `“bitrate”` property

The `“hw-address”` property

The `“mode”` property

The `“perm-hw-address”` property

The `“wireless-capabilities”` property

The `“access-point-added”` signal

The `“access-point-removed”` signal