From 81836c2d44802b4cca833d7775dd627e0797a7e2 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Fri, 28 Aug 2015 01:13:48 +0200 Subject: Imported Upstream version 1.0.6 --- docs/libnm/Makefile.am | 3 +- docs/libnm/Makefile.in | 3 +- docs/libnm/html/NMAccessPoint.html | 72 ++++++++- docs/libnm/html/NMClient.html | 30 +++- docs/libnm/html/NMDevice.html | 99 +++++++++--- docs/libnm/html/NMDeviceWifi.html | 141 ++++++++++++++++- docs/libnm/html/NMSettingConnection.html | 60 +++++++- docs/libnm/html/NMSettingWired.html | 221 ++++++++++++++++++++++++++- docs/libnm/html/api-index-full.html | 127 +++++++++++++++ docs/libnm/html/index.html | 2 +- docs/libnm/html/index.sgml | 45 +++++- docs/libnm/html/libnm-nm-dbus-interface.html | 64 +++++++- docs/libnm/html/libnm-nm-utils.html | 208 +++++++++++++++++++++---- docs/libnm/html/libnm-nm-version.html | 48 ++++-- docs/libnm/html/libnm.devhelp2 | 45 +++++- docs/libnm/html/object-tree.html | 2 + docs/libnm/libnm-sections.txt | 35 ++++- docs/libnm/libnm.types | 2 + docs/libnm/version.xml | 2 +- 19 files changed, 1126 insertions(+), 83 deletions(-) (limited to 'docs/libnm') diff --git a/docs/libnm/Makefile.am b/docs/libnm/Makefile.am index 28938f89..2525856d 100644 --- a/docs/libnm/Makefile.am +++ b/docs/libnm/Makefile.am @@ -53,7 +53,8 @@ IGNORE_HFILES= \ nm-setting-private.h \ nm-types.h \ nm-utils-private.h \ - nm-vpn-plugin-old.h + nm-vpn-plugin-old.h \ + nm-core-tests-enum-types.h # Images to copy into HTML directory. HTML_IMAGES = libnm.png diff --git a/docs/libnm/Makefile.in b/docs/libnm/Makefile.in index 54ad3287..bb41ba14 100644 --- a/docs/libnm/Makefile.in +++ b/docs/libnm/Makefile.in @@ -455,7 +455,8 @@ IGNORE_HFILES = \ nm-setting-private.h \ nm-types.h \ nm-utils-private.h \ - nm-vpn-plugin-old.h + nm-vpn-plugin-old.h \ + nm-core-tests-enum-types.h # Images to copy into HTML directory. diff --git a/docs/libnm/html/NMAccessPoint.html b/docs/libnm/html/NMAccessPoint.html index 1daa7c01..4aa880dc 100644 --- a/docs/libnm/html/NMAccessPoint.html +++ b/docs/libnm/html/NMAccessPoint.html @@ -114,6 +114,14 @@ +gint + + +nm_access_point_get_last_seen () + + + + GPtrArray * @@ -163,6 +171,11 @@ Read +gint +last-seen +Read + + guint max-bitrate Read @@ -242,6 +255,10 @@ #define +NM_ACCESS_POINT_LAST_SEEN + + +#define NM_ACCESS_POINT_HW_ADDRESS @@ -498,6 +515,35 @@ nm_access_point_get_strength ( +

nm_access_point_get_last_seen ()

+
gint
+nm_access_point_get_last_seen (NMAccessPoint *ap);
+

Returns the timestamp (in CLOCK_BOOTTIME seconds) for the last time the +access point was found in scan results. A value of -1 means the access +point has not been found in a scan.

+
+

Parameters

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

ap

a NMAccessPoint

 
+
+
+

Returns

+

the last seen time in seconds

+
+

Since: 1.0.6

+ +
+

nm_access_point_filter_connections ()

GPtrArray *
 nm_access_point_filter_connections (NMAccessPoint *ap,
@@ -512,7 +558,7 @@ use NMDevice using nm_device_filter_connections() and finally filter that list
 with this function.

-

Parameters

+

Parameters

@@ -535,7 +581,7 @@ filter.

-

Returns

+

Returns

an array of NMConnections that could be activated with the given ap . The array should @@ -555,7 +601,7 @@ the connection may be activated with that AP. The connection must match the 's SSID, (if given) BSSID, and other attributes like security settings, channel, band, etc.

-

Parameters

+

Parameters

@@ -579,7 +625,7 @@ against

-

Returns

+

Returns

TRUE if the connection may be activated with this Wi-Fi AP, FALSE if it cannot be.

@@ -642,6 +688,12 @@ against


+

NM_ACCESS_POINT_LAST_SEEN

+
#define NM_ACCESS_POINT_LAST_SEEN   "last-seen"
+
+
+
+

NM_ACCESS_POINT_HW_ADDRESS

#define NM_ACCESS_POINT_HW_ADDRESS  "hw-address"
 
@@ -686,6 +738,18 @@ against


+

The “last-seen” property

+
  “last-seen”                gint
+

The timestamp (in CLOCK_BOOTTIME seconds) for the last time the +access point was found in scan results. A value of -1 means the +access point has not been found in a scan.

+

Flags: Read

+

Allowed values: >= -1

+

Default value: -1

+

Since: 1.0.6

+
+
+

The “max-bitrate” property

  “max-bitrate”              guint

The maximum bit rate of the access point in kbit/s.

diff --git a/docs/libnm/html/NMClient.html b/docs/libnm/html/NMClient.html index 950d7251..1914ba7b 100644 --- a/docs/libnm/html/NMClient.html +++ b/docs/libnm/html/NMClient.html @@ -523,6 +523,11 @@ Read +guint +metered +Read + + gboolean networking-enabled Read / Write @@ -710,6 +715,10 @@ #define +NM_CLIENT_METERED + + +#define NM_CLIENT_DEVICE_ADDED @@ -2989,6 +2998,12 @@ nm_client_reload_connections_finish (
+

NM_CLIENT_METERED

+
#define NM_CLIENT_METERED "metered"
+
+
+
+

NM_CLIENT_DEVICE_ADDED

#define NM_CLIENT_DEVICE_ADDED "device-added"
 
@@ -3023,7 +3038,7 @@ nm_client_reload_connections_finish (NMClientPermission values indicate various permissions that NetworkManager clients can obtain to perform certain tasks on behalf of the current user.

-

Members

+

Members

@@ -3143,7 +3158,7 @@ clients can obtain to perform certain tasks on behalf of the current user.

NMClientPermissionResult values indicate what authorizations and permissions the user requires to obtain a given NMClientPermission

-

Members

+

Members

@@ -3192,7 +3207,7 @@ the user requires to obtain a given NMManagerError, NMSettingsError, NMAgentManagerError, and NMConnectionError.

-

Members

+

Members

@@ -3299,6 +3314,15 @@ modified by calling
+

The “metered” property

+
  “metered”                  guint
+

Whether the connectivity is metered.

+

Flags: Read

+

Default value: 0

+

Since: 1.0.6

+
+
+

The “networking-enabled” property

  “networking-enabled”       gboolean

Whether networking is enabled.

diff --git a/docs/libnm/html/NMDevice.html b/docs/libnm/html/NMDevice.html index 8065247c..ff38ac07 100644 --- a/docs/libnm/html/NMDevice.html +++ b/docs/libnm/html/NMDevice.html @@ -255,6 +255,14 @@
+ + + + + + + + + @@ -601,6 +614,10 @@ + + + +
+NMMetered + +nm_device_get_metered () +
char ** @@ -446,6 +454,11 @@
guintmeteredRead
guint mtu Read
#define NM_DEVICE_MTU
#defineNM_DEVICE_METERED
@@ -1410,6 +1427,33 @@ product name is unknown, this returns the interface name.


+

nm_device_get_metered ()

+
NMMetered
+nm_device_get_metered (NMDevice *device);
+

Gets the metered setting of a NMDevice.

+
+

Parameters

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

device

a NMDevice

 
+
+
+

Returns

+

the metered setting.

+
+

Since: 1.0.6

+
+
+

nm_device_disambiguate_names ()

char **
 nm_device_disambiguate_names (NMDevice **devices,
@@ -1418,7 +1462,7 @@ nm_device_disambiguate_names (devices
 .

-

Parameters

+

Parameters

@@ -1441,7 +1485,7 @@ devices in devices
-

Returns

+

Returns

the device names.

[transfer full][array zero-terminated=1]

@@ -1457,7 +1501,7 @@ nm_device_disconnect ( -

Parameters

+

Parameters

@@ -1484,7 +1528,7 @@ request.

-

Returns

+

Returns

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

@@ -1501,7 +1545,7 @@ nm_device_disconnect_async ( -

Parameters

+

Parameters

@@ -1543,7 +1587,7 @@ nm_device_disconnect_finish (GError **error);

Gets the result of a call to nm_device_disconnect_async().

-

Parameters

+

Parameters

@@ -1570,7 +1614,7 @@ nm_device_disconnect_finish ( -

Returns

+

Returns

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

@@ -1584,7 +1628,7 @@ nm_device_delete (GError **error);

Deletes the software device. Hardware devices can't be deleted.

-

Parameters

+

Parameters

@@ -1611,7 +1655,7 @@ nm_device_delete ( -

Returns

+

Returns

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

@@ -1627,7 +1671,7 @@ nm_device_delete_async ( -

Parameters

+

Parameters

@@ -1669,7 +1713,7 @@ nm_device_delete_finish (GError **error);

Gets the result of a call to nm_device_delete_async().

-

Parameters

+

Parameters

@@ -1696,7 +1740,7 @@ nm_device_delete_finish ( -

Returns

+

Returns

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

@@ -1718,7 +1762,7 @@ Ethernet, Bluetooth, Wi-Fi WPA connections, or any other connection that is incompatible with the device. To get the full list of connections see nm_client_get_connections().

-

Parameters

+

Parameters

@@ -1740,7 +1784,7 @@ incompatible with the device. To get the full list of connections see
-

Returns

+

Returns

an array of NMConnections that could be activated with the given device . The array @@ -1763,7 +1807,7 @@ network, and will not be valid if it describes a WPA network, or if it is an Ethernet, Bluetooth, WWAN, etc connection that is incompatible with the device.

-

Parameters

+

Parameters

@@ -1787,7 +1831,7 @@ against

-

Returns

+

Returns

TRUE if the connection may be activated with this device, FALSE if is incompatible with the device's capabilities and characteristics.

@@ -1811,7 +1855,7 @@ device.

compatibility of the given device and connection. But, in addition, it sets GError when FALSE is returned.

-

Parameters

+

Parameters

@@ -1840,7 +1884,7 @@ against

-

Returns

+

Returns

TRUE if the connection may be activated with this device, FALSE if is incompatible with the device's capabilities and characteristics.

@@ -1854,7 +1898,7 @@ nm_device_get_setting_type (device .

-

Parameters

+

Parameters

@@ -1869,7 +1913,7 @@ that can be used on device
-

Returns

+

Returns

device 's associated NMSetting type

@@ -2014,6 +2058,12 @@ that can be used on device
#define NM_DEVICE_MTU "mtu"
 
+
+
+

NM_DEVICE_METERED

+
#define NM_DEVICE_METERED "metered"
+
+

Property Details

@@ -2142,6 +2192,15 @@ operations like addressing and routing.


+

The “metered” property

+
  “metered”                  guint
+

Whether the device is metered.

+

Flags: Read

+

Default value: 0

+

Since: 1.0.6

+
+
+

The “mtu” property

  “mtu”                      guint

The MTU of the device.

diff --git a/docs/libnm/html/NMDeviceWifi.html b/docs/libnm/html/NMDeviceWifi.html index db0dca47..776aba14 100644 --- a/docs/libnm/html/NMDeviceWifi.html +++ b/docs/libnm/html/NMDeviceWifi.html @@ -113,6 +113,14 @@ +gboolean + + +nm_device_wifi_request_scan_options () + + + + void @@ -121,6 +129,14 @@ +void + + +nm_device_wifi_request_scan_options_async () + + + + gboolean @@ -527,6 +543,64 @@ set.


+

nm_device_wifi_request_scan_options ()

+
gboolean
+nm_device_wifi_request_scan_options (NMDeviceWifi *device,
+                                     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 +after that for the scan to complete. +This is the same as nm_device_wifi_request_scan + except it accepts options + +for the scanning. The argument is the dictionary passed to RequestScan() +D-Bus call. Valid otions inside the dictionary are: +'ssids' => array of SSIDs (saay)

+
+

Parameters

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

device

a NMDeviceWifi

 

options

dictionary with options for RequestScan(), or NULL

 

cancellable

a GCancellable, or NULL

 

error

location for a GError, or NULL

 
+
+
+

Returns

+

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

+
+

Since: 1.0.6

+
+
+

nm_device_wifi_request_scan_async ()

void
 nm_device_wifi_request_scan_async (NMDeviceWifi *device,
@@ -539,7 +613,7 @@ nm_device_wifi_request_scan_async (
 
-

Parameters

+

Parameters

@@ -574,6 +648,67 @@ that for the scan to complete.


+

nm_device_wifi_request_scan_options_async ()

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

Request NM to scan for access points on device +. Note that callback + will be +called immediately after requesting the scan, and it may take some time after +that for the scan to complete. +This is the same as nm_device_wifi_request_scan_async + except it accepts options + +for the scanning. The argument is the dictionary passed to RequestScan() +D-Bus call. Valid otions inside the dictionary are: +'ssids' => array of SSIDs (saay)

+
+

Parameters

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

device

a NMDeviceWifi

 

options

dictionary with options for RequestScan(), or NULL

 

cancellable

a GCancellable, or NULL

 

callback

callback to be called when the scan has been requested

 

user_data

caller-specific data passed to callback +

 
+
+

Since: 1.0.6

+
+
+

nm_device_wifi_request_scan_finish ()

gboolean
 nm_device_wifi_request_scan_finish (NMDeviceWifi *device,
@@ -581,7 +716,7 @@ nm_device_wifi_request_scan_finish (GError **error);

Gets the result of a call to nm_device_wifi_request_scan_async().

-

Parameters

+

Parameters

@@ -608,7 +743,7 @@ nm_device_wifi_request_scan_finish (
-

Returns

+

Returns

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

diff --git a/docs/libnm/html/NMSettingConnection.html b/docs/libnm/html/NMSettingConnection.html index f33e2b88..aef02658 100644 --- a/docs/libnm/html/NMSettingConnection.html +++ b/docs/libnm/html/NMSettingConnection.html @@ -241,6 +241,14 @@ nm_setting_connection_get_gateway_ping_timeout () +
+ + +
+NMMetered + +nm_setting_connection_get_metered () +
@@ -292,6 +300,11 @@ Read / Write +NMMetered +metered +Read / Write + + GStrv permissions Read / Write @@ -423,6 +436,10 @@ NM_SETTING_CONNECTION_GATEWAY_PING_TIMEOUT +#define +NM_SETTING_CONNECTION_METERED + + enum NMSettingConnectionAutoconnectSlaves @@ -1264,6 +1281,32 @@ nm_setting_connection_get_gateway_ping_timeout property.

+
+
+

nm_setting_connection_get_metered ()

+
NMMetered
+nm_setting_connection_get_metered (NMSettingConnection *setting);
+
+

Parameters

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

setting

the NMSettingConnection

 
+
+
+

Returns

+

the “metered” property of the setting.

+
+

Since: 1.0.6

+

Types and Values

@@ -1382,11 +1425,17 @@ property.


+

NM_SETTING_CONNECTION_METERED

+
#define NM_SETTING_CONNECTION_METERED        "metered"
+
+
+
+

enum NMSettingConnectionAutoconnectSlaves

NMSettingConnectionAutoconnectSlaves values indicate whether slave connections should be activated when master is activated.

-

Members

+

Members

@@ -1512,6 +1561,15 @@ connection may be applied to the wrong interface.


+

The “metered” property

+
  “metered”                  NMMetered
+

Whether the connection is metered.

+

Flags: Read / Write

+

Default value: NM_METERED_UNKNOWN

+

Since: 1.0.6

+
+
+

The “permissions” property

  “permissions”              GStrv

An array of strings defining what access a given user has to this diff --git a/docs/libnm/html/NMSettingWired.html b/docs/libnm/html/NMSettingWired.html index 6255f6c8..1ee7de44 100644 --- a/docs/libnm/html/NMSettingWired.html +++ b/docs/libnm/html/NMSettingWired.html @@ -215,6 +215,21 @@ nm_setting_wired_get_valid_s390_options () +

+ + + + + + +
+NMSettingWiredWakeOnLan + +nm_setting_wired_get_wake_on_lan () +
const char * + +nm_setting_wired_get_wake_on_lan_password () +
@@ -288,6 +303,17 @@ speed Read / Write / Construct + +guint +wake-on-lan +Read / Write / Construct + + + +gchar * +wake-on-lan-password +Read / Write +
@@ -304,6 +330,10 @@ NM_SETTING_WIRED_SETTING_NAME +enum +NMSettingWiredWakeOnLan + + #define NM_SETTING_WIRED_PORT @@ -347,12 +377,22 @@ #define NM_SETTING_WIRED_S390_OPTIONS + +#define +NM_SETTING_WIRED_WAKE_ON_LAN + + +#define +NM_SETTING_WIRED_WAKE_ON_LAN_PASSWORD +

Object Hierarchy

-
    GObject
+
    GFlags
+    ╰── NMSettingWiredWakeOnLan
+    GObject
     ╰── NMSetting
         ╰── NMSettingWired
 
@@ -1055,6 +1095,62 @@ nm_setting_wired_get_valid_s390_options

[transfer none]

+
+
+

nm_setting_wired_get_wake_on_lan ()

+
NMSettingWiredWakeOnLan
+nm_setting_wired_get_wake_on_lan (NMSettingWired *setting);
+

Returns the Wake-on-LAN options enabled for the connection

+
+

Parameters

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

setting

the NMSettingWired

 
+
+
+

Returns

+

the Wake-on-LAN options

+
+

Since: 1.0.6

+
+
+
+

nm_setting_wired_get_wake_on_lan_password ()

+
const char *
+nm_setting_wired_get_wake_on_lan_password
+                               (NMSettingWired *setting);
+

Returns the Wake-on-LAN password. This only applies to +NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC.

+
+

Parameters

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

setting

the NMSettingWired

 
+
+
+

Returns

+

the Wake-on-LAN setting password, or NULL if there is no password.

+
+

Since: 1.0.6

+

Types and Values

@@ -1065,6 +1161,93 @@ nm_setting_wired_get_valid_s390_options

+

enum NMSettingWiredWakeOnLan

+

Options for “wake-on-lan”. Note that not all options +are supported by all devices.

+
+

Members

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

NM_SETTING_WIRED_WAKE_ON_LAN_NONE

+

Wake-on-LAN disabled

+
 

NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT

+

Use the default value

+
 

NM_SETTING_WIRED_WAKE_ON_LAN_PHY

+

Wake on PHY activity

+
 

NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST

+

Wake on unicast messages

+
 

NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST

+

Wake on multicast messages

+
 

NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST

+

Wake on broadcast messages

+
 

NM_SETTING_WIRED_WAKE_ON_LAN_ARP

+

Wake on ARP

+
 

NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC

+

Wake on magic packet

+
 

_NM_SETTING_WIRED_WAKE_ON_LAN_LAST

  

NM_SETTING_WIRED_WAKE_ON_LAN_ALL

+

Wake on all events

+
 
+
+

Since: 1.0.6

+
+
+

NM_SETTING_WIRED_PORT

#define NM_SETTING_WIRED_PORT "port"
 
@@ -1129,6 +1312,18 @@ nm_setting_wired_get_valid_s390_options
#define NM_SETTING_WIRED_S390_OPTIONS "s390-options"
 
+
+
+

NM_SETTING_WIRED_WAKE_ON_LAN

+
#define NM_SETTING_WIRED_WAKE_ON_LAN "wake-on-lan"
+
+
+
+
+

NM_SETTING_WIRED_WAKE_ON_LAN_PASSWORD

+
#define NM_SETTING_WIRED_WAKE_ON_LAN_PASSWORD "wake-on-lan-password"
+
+

Property Details

@@ -1241,6 +1436,30 @@ Mbit/s, ie 100 == 100Mbit/s.

Flags: Read / Write / Construct

Default value: 0

+
+
+

The “wake-on-lan” property

+
  “wake-on-lan”              guint
+

The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. +May be any combination of NM_SETTING_WIRED_WAKE_ON_LAN_PHY, +NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST, NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST, +NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST, NM_SETTING_WIRED_WAKE_ON_LAN_ARP, +NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC.

+

Flags: Read / Write / Construct

+

Default value: 1

+

Since: 1.0.6

+
+
+
+

The “wake-on-lan-password” property

+
  “wake-on-lan-password”     gchar *
+

If specified, the password used with magic-packet-based +Wake-on-LAN, represented as an Ethernet MAC address. If NULL, +no password will be required.

+

Flags: Read / Write

+

Default value: NULL

+

Since: 1.0.6

+