From e152ec7bf4ba252ff9d3eb13eabd417b931dac9a Mon Sep 17 00:00:00 2001 From: Iain Lane Date: Mon, 24 Sep 2018 09:29:55 +0100 Subject: Import Upstream version 1.12.2 --- docs/libnm/html/NMDeviceWifi.html | 187 +++++++++++++++++++++++++------------- 1 file changed, 126 insertions(+), 61 deletions(-) (limited to 'docs/libnm/html/NMDeviceWifi.html') diff --git a/docs/libnm/html/NMDeviceWifi.html b/docs/libnm/html/NMDeviceWifi.html index eacae65f..ba3a213b 100644 --- a/docs/libnm/html/NMDeviceWifi.html +++ b/docs/libnm/html/NMDeviceWifi.html @@ -8,7 +8,7 @@ - + @@ -67,7 +67,7 @@ -guint32 +guint32 nm_device_wifi_get_bitrate () @@ -98,7 +98,7 @@ -const GPtrArray * +const GPtrArray * nm_device_wifi_get_access_points () @@ -106,7 +106,15 @@ -gboolean +gint64 + + +nm_device_wifi_get_last_scan () + + + + +gboolean nm_device_wifi_request_scan () @@ -114,7 +122,7 @@ -gboolean +gboolean nm_device_wifi_request_scan_options () @@ -138,7 +146,7 @@ -gboolean +gboolean nm_device_wifi_request_scan_finish () @@ -158,7 +166,7 @@ -GPtrArray * +GPtrArray * access-points Read @@ -169,24 +177,29 @@ Read -guint +guint bitrate Read -gchar * +gchar * hw-address Read +gint64 +last-scan +Read + + NM80211Mode mode Read -gchar * +gchar * perm-hw-address Read @@ -210,12 +223,12 @@ void access-point-added -Run First +Run First void access-point-removed -Run First +Run First @@ -257,6 +270,10 @@ NM_DEVICE_WIFI_ACCESS_POINTS +#define +NM_DEVICE_WIFI_LAST_SCAN + +   NMDeviceWifi @@ -265,7 +282,7 @@

Object Hierarchy

-
    GObject
+
    GObject
     ╰── NMObject
         ╰── NMDevice
             ╰── NMDeviceWifi
@@ -275,7 +292,7 @@
 

Implemented Interfaces

NMDeviceWifi implements - GInitable and GAsyncInitable.

+ GInitable and GAsyncInitable.

Description

@@ -365,7 +382,7 @@ nm_device_wifi_get_mode (

nm_device_wifi_get_bitrate ()

-
guint32
+
guint32
 nm_device_wifi_get_bitrate (NMDeviceWifi *device);

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

@@ -438,7 +455,7 @@ nm_device_wifi_get_active_access_point

Returns

-

the access point or NULL if none is active.

+

the access point or NULL if none is active.

[transfer none]

@@ -474,14 +491,14 @@ nm_device_wifi_get_access_point_by_path

Returns

-

the access point or NULL if none is found.

+

the access point or NULL if none is found.

[transfer none]


nm_device_wifi_get_access_points ()

-
const GPtrArray *
+
const GPtrArray *
 nm_device_wifi_get_access_points (NMDeviceWifi *device);

Gets all the scanned access points of the NMDeviceWifi.

@@ -501,7 +518,7 @@ nm_device_wifi_get_access_points (

Returns

-

a GPtrArray containing all the +

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

[element-type NMAccessPoint]

@@ -509,11 +526,41 @@ The returned array is owned by the client and should not be modified.


+

nm_device_wifi_get_last_scan ()

+
gint64
+nm_device_wifi_get_last_scan (NMDeviceWifi *device);
+

Returns the timestamp (in CLOCK_BOOTTIME milliseconds) for the last finished +network scan. A value of -1 means the device never scanned for access points.

+

Use nm_utils_get_timestamp_msec() to obtain current time value suitable for +comparing to this value.

+
+

Parameters

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

device

a NMDeviceWifi

 
+
+
+

Returns

+

the last scan time in seconds

+
+

Since: 1.12

+
+
+

nm_device_wifi_request_scan ()

-
gboolean
+
gboolean
 nm_device_wifi_request_scan (NMDeviceWifi *device,
-                             GCancellable *cancellable,
-                             GError **error);
+ GCancellable *cancellable, + GError **error);

Request NM to scan for access points on device . Note that the function returns immediately after requesting the scan, and it may take some time @@ -534,12 +581,12 @@ after that for the scan to complete.

cancellable

-

a GCancellable, or NULL

+

a GCancellable, or NULL

 

error

-

location for a GError, or NULL

+

location for a GError, or NULL

  @@ -547,7 +594,7 @@ after that for the scan to complete.

Returns

-

TRUE on success, FALSE on error, in which case error +

TRUE on success, FALSE on error, in which case error will be set.

@@ -555,11 +602,11 @@ set.


nm_device_wifi_request_scan_options ()

-
gboolean
+
gboolean
 nm_device_wifi_request_scan_options (NMDeviceWifi *device,
-                                     GVariant *options,
-                                     GCancellable *cancellable,
-                                     GError **error);
+ GVariant *options, + GCancellable *cancellable, + GError **error);

Request NM to scan for access points on device . Note that the function returns immediately after requesting the scan, and it may take some time @@ -586,17 +633,17 @@ D-Bus call. Valid otions inside the dictionary are:

options

-

dictionary with options for RequestScan(), or NULL

+

dictionary with options for RequestScan(), or NULL

 

cancellable

-

a GCancellable, or NULL

+

a GCancellable, or NULL

 

error

-

location for a GError, or NULL

+

location for a GError, or NULL

  @@ -604,7 +651,7 @@ D-Bus call. Valid otions inside the dictionary are:

Returns

-

TRUE on success, FALSE on error, in which case error +

TRUE on success, FALSE on error, in which case error will be set.

@@ -615,9 +662,9 @@ set.

nm_device_wifi_request_scan_async ()

void
 nm_device_wifi_request_scan_async (NMDeviceWifi *device,
-                                   GCancellable *cancellable,
-                                   GAsyncReadyCallback callback,
-                                   gpointer user_data);
+ GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data);

Request NM to scan for access points on device . Note that callback will be @@ -639,7 +686,7 @@ that for the scan to complete.

cancellable

-

a GCancellable, or NULL

+

a GCancellable, or NULL

  @@ -663,10 +710,10 @@ that for the scan to complete.

void
 nm_device_wifi_request_scan_options_async
                                (NMDeviceWifi *device,
-                                GVariant *options,
-                                GCancellable *cancellable,
-                                GAsyncReadyCallback callback,
-                                gpointer user_data);
+ GVariant *options, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data);

Request NM to scan for access points on device . Note that callback will be @@ -694,12 +741,12 @@ D-Bus call. Valid otions inside the dictionary are:

options

-

dictionary with options for RequestScan(), or NULL

+

dictionary with options for RequestScan(), or NULL

 

cancellable

-

a GCancellable, or NULL

+

a GCancellable, or NULL

  @@ -721,10 +768,10 @@ D-Bus call. Valid otions inside the dictionary are:

nm_device_wifi_request_scan_finish ()

-
gboolean
+
gboolean
 nm_device_wifi_request_scan_finish (NMDeviceWifi *device,
-                                    GAsyncResult *result,
-                                    GError **error);
+ GAsyncResult *result, + GError **error);

Gets the result of a call to nm_device_wifi_request_scan_async().

Parameters

@@ -742,12 +789,12 @@ nm_device_wifi_request_scan_finish (

result

-

the result passed to the GAsyncReadyCallback

+

the result passed to the GAsyncReadyCallback

 

error

-

location for a GError, or NULL

+

location for a GError, or NULL

  @@ -755,7 +802,7 @@ nm_device_wifi_request_scan_finish (

Returns

-

TRUE on success, FALSE on error, in which case error +

TRUE on success, FALSE on error, in which case error will be set.

@@ -806,6 +853,12 @@ set.


+

NM_DEVICE_WIFI_LAST_SCAN

+
#define NM_DEVICE_WIFI_LAST_SCAN           "last-scan"
+
+
+
+

NMDeviceWifi

typedef struct _NMDeviceWifi NMDeviceWifi;
@@ -814,9 +867,9 @@ set.

Property Details

The “access-points” property

-
  “access-points”            GPtrArray *
+
  “access-points”            GPtrArray *

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

-

Element-type: NMAccessPoint

+

[type GPtrArray(NMAccessPoint)]

Flags: Read


@@ -829,7 +882,7 @@ set.


The “bitrate” property

-
  “bitrate”                  guint
+
  “bitrate”                  guint

The bit rate of the device in kbit/s.

Flags: Read

Default value: 0

@@ -837,13 +890,25 @@ set.


The “hw-address” property

-
  “hw-address”               gchar *
+
  “hw-address”               gchar *

The hardware (MAC) address of the device.

Flags: Read

Default value: NULL


+

The “last-scan” property

+
  “last-scan”                gint64
+

The timestamp (in CLOCK_BOOTTIME seconds) for the last finished +network scan. A value of -1 means the device never scanned for +access points.

+

Flags: Read

+

Allowed values: >= -1

+

Default value: -1

+

Since: 1.12

+
+
+

The “mode” property

  “mode”                     NM80211Mode

The mode of the device.

@@ -853,7 +918,7 @@ set.


The “perm-hw-address” property

-
  “perm-hw-address”          gchar *
+
  “perm-hw-address”          gchar *

The hardware (MAC) address of the device.

Flags: Read

Default value: NULL

@@ -872,8 +937,8 @@ set.

The “access-point-added” signal

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

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

Parameters

@@ -902,15 +967,15 @@ user_function (
-

Flags: Run First

+

Flags: Run First


The “access-point-removed” signal

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

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

Parameters

@@ -939,11 +1004,11 @@ user_function (
-

Flags: Run First

+

Flags: Run First

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