From 7514efc2f38c9ace4557d4e69d68e7d380389030 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Fri, 26 Aug 2016 02:18:32 +0200 Subject: Imported Upstream version 1.4.0 --- docs/libnm-glib/html/NMDevice.html | 176 ++++++++++++++++++------------------- 1 file changed, 88 insertions(+), 88 deletions(-) (limited to 'docs/libnm-glib/html/NMDevice.html') diff --git a/docs/libnm-glib/html/NMDevice.html b/docs/libnm-glib/html/NMDevice.html index f92c1585..2ea3996f 100644 --- a/docs/libnm-glib/html/NMDevice.html +++ b/docs/libnm-glib/html/NMDevice.html @@ -8,7 +8,7 @@ - + @@ -668,7 +668,7 @@ nm_device_error_quark (void);

Registers an error quark for NMDevice if necessary.

-

Returns

+

Returns

the error quark used for NMDevice errors.

Since: 0.9.10

@@ -681,7 +681,7 @@ nm_device_new (const char *path);

Creates a new NMDevice.

-

Parameters

+

Parameters

@@ -703,7 +703,7 @@ nm_device_new ( -

Returns

+

Returns

a new device.

[transfer full]

@@ -715,7 +715,7 @@ nm_device_new (NMDevice *device);

Gets the interface name of the NMDevice.

-

Parameters

+

Parameters

@@ -730,7 +730,7 @@ nm_device_get_iface ( -

Returns

+

Returns

the interface of the device. This is the internal string used by the device, and must not be modified.

@@ -743,7 +743,7 @@ nm_device_get_ip_iface (NMDevice over which IP traffic flows when the device is in the ACTIVATED state.

-

Parameters

+

Parameters

@@ -758,7 +758,7 @@ when the device is in the ACTIVATED state.

-

Returns

+

Returns

the IP traffic interface of the device. This is the internal string used by the device, and must not be modified.

@@ -770,7 +770,7 @@ used by the device, and must not be modified.

nm_device_get_device_type (NMDevice *device);

Returns the numeric type of the NMDevice, ie Ethernet, Wi-Fi, etc.

-

Parameters

+

Parameters

@@ -785,7 +785,7 @@ nm_device_get_device_type ( -

Returns

+

Returns

the device type

@@ -796,7 +796,7 @@ nm_device_get_device_type (NMDevice *device);

Gets the Unique Device Identifier of the NMDevice.

-

Parameters

+

Parameters

@@ -811,7 +811,7 @@ nm_device_get_udi ( -

Returns

+

Returns

the Unique Device Identifier of the device. This identifier may be used to gather more information about the device from various operating system services like udev or sysfs.

@@ -824,7 +824,7 @@ system services like udev or sysfs.

nm_device_get_driver (NMDevice *device);

Gets the driver of the NMDevice.

-

Parameters

+

Parameters

@@ -839,7 +839,7 @@ nm_device_get_driver ( -

Returns

+

Returns

the driver of the device. This is the internal string used by the device, and must not be modified.

@@ -851,7 +851,7 @@ device, and must not be modified.

nm_device_get_driver_version (NMDevice *device);

Gets the driver version of the NMDevice.

-

Parameters

+

Parameters

@@ -866,7 +866,7 @@ nm_device_get_driver_version ( -

Returns

+

Returns

the version of the device driver. This is the internal string used by the device, and must not be modified.

@@ -878,7 +878,7 @@ device, and must not be modified.

nm_device_get_firmware_version (NMDevice *device);

Gets the firmware version of the NMDevice.

-

Parameters

+

Parameters

@@ -893,7 +893,7 @@ nm_device_get_firmware_version (
-

Returns

+

Returns

the firmware version of the device. This is the internal string used by the device, and must not be modified.

@@ -907,7 +907,7 @@ nm_device_get_type_description (device is.

-

Parameters

+

Parameters

@@ -922,7 +922,7 @@ nm_device_get_type_description (
-

Returns

+

Returns

the type description of the device. This is the internal string used by the device, and must not be modified.

@@ -936,7 +936,7 @@ nm_device_get_hw_address (device .

-

Parameters

+

Parameters

@@ -951,7 +951,7 @@ nm_device_get_hw_address ( -

Returns

+

Returns

the current MAC of the device, or NULL. This is the internal string used by the device, and must not be modified.

@@ -964,7 +964,7 @@ This is the internal string used by the device, and must not be modified.

nm_device_get_capabilities (NMDevice *device);

Gets the device' capabilities.

-

Parameters

+

Parameters

@@ -979,7 +979,7 @@ nm_device_get_capabilities ( -

Returns

+

Returns

the capabilities

@@ -990,7 +990,7 @@ nm_device_get_capabilities (NMDevice *device);

Whether the NMDevice is managed by NetworkManager.

-

Parameters

+

Parameters

@@ -1005,7 +1005,7 @@ nm_device_get_managed ( -

Returns

+

Returns

TRUE if the device is managed by NetworkManager

@@ -1017,7 +1017,7 @@ nm_device_set_managed (gboolean managed);

Enables or disables management of NMDevice by NetworkManager.

-

Parameters

+

Parameters

@@ -1047,7 +1047,7 @@ nm_device_set_managed (NMDevice *device);

Whether the NMDevice can be autoconnected.

-

Parameters

+

Parameters

@@ -1062,7 +1062,7 @@ nm_device_get_autoconnect ( -

Returns

+

Returns

TRUE if the device is allowed to be autoconnected

@@ -1074,7 +1074,7 @@ nm_device_set_autoconnect (gboolean autoconnect);

Enables or disables automatic activation of the NMDevice.

-

Parameters

+

Parameters

@@ -1104,7 +1104,7 @@ nm_device_get_firmware_missing (Indicates that firmware required for the device's operation is likely to be missing.

-

Parameters

+

Parameters

@@ -1119,7 +1119,7 @@ to be missing.

-

Returns

+

Returns

TRUE if firmware required for the device's operation is likely to be missing.

@@ -1134,7 +1134,7 @@ nm_device_get_ip4_config (nm_active_connection_get_ip4_config(), which also works with VPN connections.

-

Parameters

+

Parameters

@@ -1149,7 +1149,7 @@ connections.

-

Returns

+

Returns

the NMIP4Config or NULL if the device is not activated.

[transfer none]

@@ -1164,7 +1164,7 @@ nm_device_get_dhcp4_config (nm_active_connection_get_dhcp4_config(), which also works with VPN connections.

-

Parameters

+

Parameters

@@ -1179,7 +1179,7 @@ connections.

-

Returns

+

Returns

the NMDHCP4Config or NULL if the device is not activated or not using DHCP.

[transfer none]

@@ -1195,7 +1195,7 @@ nm_device_get_ip6_config (nm_active_connection_get_ip6_config(), which also works with VPN connections.

-

Parameters

+

Parameters

@@ -1210,7 +1210,7 @@ connections.

-

Returns

+

Returns

the NMIP6Config or NULL if the device is not activated.

[transfer none]

@@ -1225,7 +1225,7 @@ nm_device_get_dhcp6_config (nm_active_connection_get_dhcp6_config(), which also works with VPN connections.

-

Parameters

+

Parameters

@@ -1240,7 +1240,7 @@ connections.

-

Returns

+

Returns

the NMDHCP6Config or NULL if the device is not activated or not using DHCP.

[transfer none]

@@ -1253,7 +1253,7 @@ using DHCP.

nm_device_get_state (NMDevice *device);

Gets the current NMDevice state.

-

Parameters

+

Parameters

@@ -1268,7 +1268,7 @@ nm_device_get_state ( -

Returns

+

Returns

the current device state

@@ -1282,7 +1282,7 @@ nm_device_get_state_reason (reason argument).

-

Parameters

+

Parameters

@@ -1304,7 +1304,7 @@ the state (reason
-

Returns

+

Returns

the current device state

@@ -1315,7 +1315,7 @@ the state (reason nm_device_get_active_connection (NMDevice *device);

Gets the NMActiveConnection object which owns this device during activation.

-

Parameters

+

Parameters

@@ -1330,7 +1330,7 @@ nm_device_get_active_connection (
-

Returns

+

Returns

the NMActiveConnection or NULL if the device is not part of an active connection.

[transfer none]

@@ -1341,11 +1341,11 @@ not part of an active connection.

nm_device_get_available_connections ()

const GPtrArray *
 nm_device_get_available_connections (NMDevice *device);
-

Gets the NMRemoteConnections currently known to the daemon that could +

Gets the NMRemoteConnections currently known to the daemon that could be activated on device .

-

Parameters

+

Parameters

@@ -1360,9 +1360,9 @@ be activated on device
-

Returns

+

Returns

the GPtrArray -containing NMRemoteConnections. This is the internal copy used by +containing NMRemoteConnections. This is the internal copy used by the connection, and must not be modified.

[element-type NMRemoteConnection]

@@ -1375,10 +1375,10 @@ the connection, and must not be modified.

nm_device_get_physical_port_id (NMDevice *device);

Gets the physical port ID of the NMDevice. If non-NULL, this is an opaque string that can be used to recognize when -seemingly-unrelated NMDevices are actually just different virtual +seemingly-unrelated NMDevices are actually just different virtual ports on a single physical port. (Eg, NPAR / SR-IOV.)

-

Parameters

+

Parameters

@@ -1393,7 +1393,7 @@ ports on a single physical port. (Eg, NPAR / SR-IOV.)

-

Returns

+

Returns

the physical port ID of the device, or NULL if the port ID is unknown. This is the internal string used by the device and must not be modified.

@@ -1407,7 +1407,7 @@ must not be modified.

nm_device_get_mtu (NMDevice *device);

Gets the MTU of the NMDevice.

-

Parameters

+

Parameters

@@ -1422,7 +1422,7 @@ nm_device_get_mtu ( -

Returns

+

Returns

the MTU of the device.

Since: 0.9.10

@@ -1434,7 +1434,7 @@ nm_device_get_mtu (NMDevice *device);

Whether the device is a software device.

-

Parameters

+

Parameters

@@ -1449,7 +1449,7 @@ nm_device_is_software ( -

Returns

+

Returns

TRUE if device is a software device, FALSE if it is a hardware device.

@@ -1461,7 +1461,7 @@ is a software device, FALSE if it is a hardware dev
gboolean
 nm_device_is_real (NMDevice *device);
-

Parameters

+

Parameters

@@ -1476,7 +1476,7 @@ nm_device_is_real ( -

Returns

+

Returns

TRUE if the device exists, or FALSE if it is a placeholder device that could be automatically created by NetworkManager if one of its “available-connections” was activated.

@@ -1490,7 +1490,7 @@ that could be automatically created by NetworkManager if one of its nm_device_get_product (NMDevice *device);

Gets the product string of the NMDevice.

-

Parameters

+

Parameters

@@ -1505,7 +1505,7 @@ nm_device_get_product ( -

Returns

+

Returns

the product name of the device. This is the internal string used by the device, and must not be modified.

@@ -1517,7 +1517,7 @@ device, and must not be modified.

nm_device_get_vendor (NMDevice *device);

Gets the vendor string of the NMDevice.

-

Parameters

+

Parameters

@@ -1532,7 +1532,7 @@ nm_device_get_vendor ( -

Returns

+

Returns

the vendor name of the device. This is the internal string used by the device, and must not be modified.

@@ -1545,7 +1545,7 @@ nm_device_get_description (device , based on its vendor and product names.

-

Parameters

+

Parameters

@@ -1560,7 +1560,7 @@ nm_device_get_description ( -

Returns

+

Returns

a description of device . If either the vendor or the product name is unknown, this returns the interface name.

@@ -1577,7 +1577,7 @@ nm_device_disambiguate_names (devices .

-

Parameters

+

Parameters

@@ -1600,7 +1600,7 @@ devices in devices
-

Returns

+

Returns

the device names.

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

@@ -1625,7 +1625,7 @@ nm_device_disconnect ( -

Parameters

+

Parameters

@@ -1663,7 +1663,7 @@ nm_device_delete (gpointer user_data);

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

-

Parameters

+

Parameters

@@ -1710,7 +1710,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_remote_settings_list_connections().

-

Parameters

+

Parameters

@@ -1725,16 +1725,16 @@ incompatible with the device. To get the full list of connections see - +

connections

a list of NMConnection objects to filter.

a list of NMConnection objects to filter.

[element-type NMConnection]
-

Returns

+

Returns

a -list of NMConnection objects that could be activated with the given device +list of NMConnection objects that could be activated with the given device . The elements of the list are owned by their creator and should not be freed by the caller, but the returned list itself is owned by the caller and should @@ -1747,7 +1747,7 @@ be freed with g_slist_free() when it is no longer

nm_device_connection_valid ()

gboolean
 nm_device_connection_valid (NMDevice *device,
-                            NMConnection *connection);
+ NMConnection *connection);

Validates a given connection for a given NMDevice object and returns whether the connection may be activated with the device. For example if device @@ -1757,7 +1757,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

@@ -1773,7 +1773,7 @@ against

- @@ -1781,7 +1781,7 @@ against

connection

an NMConnection to validate against device +

an NMConnection to validate against device

 
-

Returns

+

Returns

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

@@ -1791,7 +1791,7 @@ if is incompatible with the device's capabilities and characteristics.

nm_device_connection_compatible ()

gboolean
 nm_device_connection_compatible (NMDevice *device,
-                                 NMConnection *connection,
+                                 NMConnection *connection,
                                  GError **error);

Validates a given connection for a given NMDevice object and returns whether the connection may be activated with the device. For example if @@ -1805,7 +1805,7 @@ device.

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

-

Parameters

+

Parameters

@@ -1821,7 +1821,7 @@ against

- @@ -1834,7 +1834,7 @@ against

connection

an NMConnection to validate against device +

an NMConnection to validate against device

 
-

Returns

+

Returns

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

@@ -1844,11 +1844,11 @@ if is incompatible with the device's capabilities and characteristics.

nm_device_get_setting_type ()

GType
 nm_device_get_setting_type (NMDevice *device);
-

Gets the (primary) NMSetting subtype associated with connections +

Gets the (primary) NMSetting subtype associated with connections that can be used on device .

-

Parameters

+

Parameters

@@ -1863,9 +1863,9 @@ that can be used on device
-

Returns

+

Returns

device -'s associated NMSetting type

+'s associated NMSetting type

Since: 0.9.10

@@ -1884,7 +1884,7 @@ that can be used on device

enum NMDeviceError

-

Members

+

Members