Tree - source-git/NetworkManager

source-git / NetworkManager

Blame docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wireless.html

Blob History Raw

Packit

<html>

Packit

5756e2

<head>

Packit

5756e2

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

Packit

5756e2

<title>org.freedesktop.NetworkManager.Device.Wireless: NetworkManager Reference Manual</title>

Packit

5756e2

<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">

Packit

5756e2

<link rel="home" href="index.html" title="NetworkManager Reference Manual">

Packit

5756e2

<link rel="up" href="ref-dbus-devices.html" title="The /org/freedesktop/NetworkManager/Devices/* objects">

Packit

5756e2

<link rel="prev" href="gdbus-org.freedesktop.NetworkManager.Device.Wired.html" title="org.freedesktop.NetworkManager.Device.Wired">

Packit

5756e2

<link rel="next" href="gdbus-org.freedesktop.NetworkManager.Device.Wpan.html" title="org.freedesktop.NetworkManager.Device.Wpan">

Packit Service

a1bd4f

<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">

Packit

5756e2

<link rel="stylesheet" href="style.css" type="text/css">

Packit

5756e2

</head>

Packit

5756e2

<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">

Packit

5756e2

Packit

5756e2

Packit

5756e2

Top  |

Packit

5756e2

                  Description  |

Packit

5756e2

                  Properties  |

Packit

5756e2

                  Signals

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

org.freedesktop.NetworkManager.Device.Wireless

Packit

5756e2

org.freedesktop.NetworkManager.Device.Wireless — Wi-Fi Device

Packit

Packit

Packit

Packit

Packit

Methods

Packit

5756e2

Packit

5756e2

GetAccessPoints    (OUT ao    access_points);

Packit

5756e2

GetAllAccessPoints (OUT ao    access_points);

Packit

5756e2

RequestScan        (IN  a{sv} options);

Packit

Packit

Packit

Packit

Signals

Packit

5756e2

Packit

5756e2

PropertiesChanged  (a{sv} properties);

Packit

5756e2

AccessPointAdded   (o     access_point);

Packit

5756e2

AccessPointRemoved (o     access_point);

Packit

Packit

Packit

Packit

Properties

Packit

5756e2

Packit

5756e2

HwAddress             readable   s

Packit

5756e2

PermHwAddress         readable   s

Packit

5756e2

Mode                  readable   u

Packit

5756e2

Bitrate               readable   u

Packit

5756e2

AccessPoints          readable   ao

Packit

5756e2

ActiveAccessPoint     readable   o

Packit

5756e2

WirelessCapabilities  readable   u

Packit

5756e2

LastScan              readable   x

Packit

Packit

Packit

Packit

Description

Packit

Packit

Packit

Packit

Method Details

Packit

5756e2

Packit

5756e2

The GetAccessPoints() method

Packit

5756e2

Packit

5756e2

GetAccessPoints (OUT ao access_points);

Packit

5756e2

Packit

5756e2

        DEPRECATED. Get the list of access points visible to this device. Note

Packit

5756e2

        that this list does not include access points which hide their SSID. To

Packit

5756e2

        retrieve a list of all access points (including hidden ones) use the

Packit

5756e2

        GetAllAccessPoints() method.

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

OUT ao access_points:

Packit

5756e2

List of access point object paths.

Packit

Packit

Packit

Packit

Packit

Packit

The GetAllAccessPoints() method

Packit

5756e2

Packit

5756e2

GetAllAccessPoints (OUT ao access_points);

Packit

5756e2

Packit

5756e2

        Get the list of all access points visible to this device, including hidden

Packit

5756e2

        ones for which the SSID is not yet known.

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

OUT ao access_points:

Packit

5756e2

List of access point object paths.

Packit

Packit

Packit

Packit

Packit

Packit

The RequestScan() method

Packit

5756e2

Packit

5756e2

RequestScan (IN  a{sv} options);

Packit

5756e2

Packit

5756e2

        Request the device to scan. To know when the scan is finished, use the "PropertiesChanged" signal from "org.freedesktop.DBus.Properties" to listen to changes to the "LastScan" property.

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

IN a{sv} options:

Packit

5756e2

Options of scan. Currently, 'ssids' option with value of "aay" type is supported.

Packit

Packit

Packit

Packit

Packit

Packit

Signal Details

Packit

5756e2

Packit

5756e2

The "PropertiesChanged" signal

Packit

5756e2

Packit

5756e2

PropertiesChanged (a{sv} properties);

Packit

5756e2

Packit

5756e2

        DEPRECATED. Use the standard "PropertiesChanged" signal from "org.freedesktop.DBus.Properties" instead which exists since version NetworkManager 1.2.0.

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

a{sv} properties:

Packit

5756e2

A dictionary containing the changed parameters.

Packit

Packit

Packit

Packit

Packit

Packit

The "AccessPointAdded" signal

Packit

5756e2

Packit

5756e2

AccessPointAdded (o access_point);

Packit

5756e2

Packit

5756e2

        Emitted when a new access point is found by the device.

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

o access_point:

Packit

5756e2

The object path of the newly found access point.

Packit

Packit

Packit

Packit

Packit

Packit

The "AccessPointRemoved" signal

Packit

5756e2

Packit

5756e2

AccessPointRemoved (o access_point);

Packit

5756e2

Packit

5756e2

        Emitted when an access point disappears from view of the device.

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

o access_point:

Packit

5756e2

The object path of the access point that has disappeared.

Packit

Packit

Packit

Packit

Packit

Packit

Property Details

Packit

5756e2

Packit

5756e2

The "HwAddress" property

Packit

5756e2

Packit

5756e2

HwAddress  readable   s

Packit

5756e2

Packit

5756e2

        The active hardware address of the device.

Packit

5756e2

Packit

5756e2

        DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0.

Packit

Packit

Packit

Packit

Packit

The "PermHwAddress" property

Packit

5756e2

Packit

5756e2

PermHwAddress  readable   s

Packit

5756e2

Packit

5756e2

        The permanent hardware address of the device.

Packit

Packit

Packit

Packit

Packit

The "Mode" property

Packit

5756e2

Packit

5756e2

Mode  readable   u

Packit

5756e2

Packit

5756e2

        The operating mode of the wireless device.

Packit

5756e2

Packit

5756e2

        Returns: NM80211Mode

Packit

Packit

Packit

Packit

Packit

The "Bitrate" property

Packit

5756e2

Packit

5756e2

Bitrate  readable   u

Packit

5756e2

Packit

5756e2

        The bit rate currently used by the wireless device, in kilobits/second

Packit

5756e2

        (Kb/s).

Packit

Packit

Packit

Packit

Packit

The "AccessPoints" property

Packit

5756e2

Packit

5756e2

AccessPoints  readable   ao

Packit

5756e2

Packit

5756e2

        List of object paths of access point visible to this wireless device.

Packit

Packit

Packit

Packit

Packit

The "ActiveAccessPoint" property

Packit

5756e2

Packit

5756e2

ActiveAccessPoint  readable   o

Packit

5756e2

Packit

5756e2

        Object path of the access point currently used by the wireless device.

Packit

Packit

Packit

Packit

Packit

The "WirelessCapabilities" property

Packit

5756e2

Packit

5756e2

WirelessCapabilities  readable   u

Packit

5756e2

Packit

5756e2

        The capabilities of the wireless device.

Packit

5756e2

Packit

5756e2

        Returns: NMDeviceWifiCapabilities

Packit

Packit

Packit

Packit

Packit

The "LastScan" property

Packit

5756e2

Packit

5756e2

LastScan  readable   x

Packit

5756e2

Packit

5756e2

        The timestamp (in CLOCK_BOOTTIME milliseconds) for the last finished network scan.

Packit

5756e2

        A value of -1 means the device never scanned for access points.

Packit

5756e2

Packit

5756e2

        Since: 1.12

Packit

Packit

Packit

Packit

Packit

Packit Service


Generated by GTK-Doc V1.33.0

Packit

5756e2

</body>

Packit

5756e2

</html>

source-git / NetworkManager

Source Code

Blame docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wireless.html

org.freedesktop.NetworkManager.Device.Wireless

Methods

Signals

Properties

Description

Method Details

The GetAccessPoints() method

The GetAllAccessPoints() method

The RequestScan() method

Signal Details

The "PropertiesChanged" signal

The "AccessPointAdded" signal

The "AccessPointRemoved" signal

Property Details

The "HwAddress" property

The "PermHwAddress" property

The "Mode" property

The "Bitrate" property

The "AccessPoints" property

The "ActiveAccessPoint" property

The "WirelessCapabilities" property

The "LastScan" property