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/html/NMDevice.html | 228 +++++++++++++++++++++--------------------- 1 file changed, 114 insertions(+), 114 deletions(-) (limited to 'docs/libnm/html/NMDevice.html') diff --git a/docs/libnm/html/NMDevice.html b/docs/libnm/html/NMDevice.html index e6e7bbec..1071031b 100644 --- a/docs/libnm/html/NMDevice.html +++ b/docs/libnm/html/NMDevice.html @@ -8,7 +8,7 @@ - + @@ -832,7 +832,7 @@ NMDevice implements nm_device_get_iface (NMDevice *device);

Gets the interface name of the NMDevice.

-

Parameters

+

Parameters

@@ -847,7 +847,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.

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

-

Parameters

+

Parameters

@@ -875,7 +875,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.

@@ -887,7 +887,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

@@ -902,7 +902,7 @@ nm_device_get_device_type ( -

Returns

+

Returns

the device type

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

Gets the Unique Device Identifier of the NMDevice.

-

Parameters

+

Parameters

@@ -928,7 +928,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.

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

nm_device_get_driver (NMDevice *device);

Gets the driver of the NMDevice.

-

Parameters

+

Parameters

@@ -956,7 +956,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.

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

nm_device_get_driver_version (NMDevice *device);

Gets the driver version of the NMDevice.

-

Parameters

+

Parameters

@@ -983,7 +983,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.

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

nm_device_get_firmware_version (NMDevice *device);

Gets the firmware version of the NMDevice.

-

Parameters

+

Parameters

@@ -1010,7 +1010,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.

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

-

Parameters

+

Parameters

@@ -1039,7 +1039,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.

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

-

Parameters

+

Parameters

@@ -1067,7 +1067,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.

@@ -1079,7 +1079,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

@@ -1094,7 +1094,7 @@ nm_device_get_capabilities ( -

Returns

+

Returns

the capabilities

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

Whether the NMDevice is managed by NetworkManager.

-

Parameters

+

Parameters

@@ -1120,7 +1120,7 @@ nm_device_get_managed ( -

Returns

+

Returns

TRUE if the device is managed by NetworkManager

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

Enables or disables management of NMDevice by NetworkManager.

-

Parameters

+

Parameters

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

Whether the NMDevice can be autoconnected.

-

Parameters

+

Parameters

@@ -1177,7 +1177,7 @@ nm_device_get_autoconnect ( -

Returns

+

Returns

TRUE if the device is allowed to be autoconnected

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

Enables or disables automatic activation of the NMDevice.

-

Parameters

+

Parameters

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

-

Parameters

+

Parameters

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

-

Returns

+

Returns

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

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

nm_device_get_nm_plugin_missing (NMDevice *device);

Indicates that the NetworkManager plugin for the device is not installed.

-

Parameters

+

Parameters

@@ -1261,7 +1261,7 @@ nm_device_get_nm_plugin_missing (
-

Returns

+

Returns

TRUE if the device plugin not installed.

Since: 1.2

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

-

Parameters

+

Parameters

@@ -1290,7 +1290,7 @@ works with VPN connections.

-

Returns

+

Returns

the IPv4 NMIPConfig, or NULL if the device is not activated.

[transfer none]

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

-

Parameters

+

Parameters

@@ -1320,7 +1320,7 @@ works with VPN connections.

-

Returns

+

Returns

the IPv4 NMDhcpConfig, or NULL if the device is not activated or not using DHCP.

[transfer none]

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

-

Parameters

+

Parameters

@@ -1350,7 +1350,7 @@ works with VPN connections.

-

Returns

+

Returns

the IPv6 NMIPConfig or NULL if the device is not activated.

[transfer none]

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

-

Parameters

+

Parameters

@@ -1379,7 +1379,7 @@ works with VPN connections.

-

Returns

+

Returns

the IPv6 NMDhcpConfig, or NULL if the device is not activated or not using DHCPv6.

[transfer none]

@@ -1392,7 +1392,7 @@ not activated or not using DHCPv6.

nm_device_get_state (NMDevice *device);

Gets the current NMDevice state.

-

Parameters

+

Parameters

@@ -1407,7 +1407,7 @@ nm_device_get_state ( -

Returns

+

Returns

the current device state

@@ -1418,7 +1418,7 @@ nm_device_get_state (NMDevice *device);

Gets the reason for entering the current NMDevice state.

-

Parameters

+

Parameters

@@ -1433,7 +1433,7 @@ nm_device_get_state_reason ( -

Returns

+

Returns

the reason for entering the current device state

@@ -1444,7 +1444,7 @@ nm_device_get_state_reason (NMDevice *device);

Gets the NMActiveConnection object which owns this device during activation.

-

Parameters

+

Parameters

@@ -1459,7 +1459,7 @@ nm_device_get_active_connection (
-

Returns

+

Returns

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

[transfer none]

@@ -1470,11 +1470,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

@@ -1489,9 +1489,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]

@@ -1503,10 +1503,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

@@ -1521,7 +1521,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.

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

nm_device_get_mtu (NMDevice *device);

Gets the MTU of the NMDevice.

-

Parameters

+

Parameters

@@ -1549,7 +1549,7 @@ nm_device_get_mtu ( -

Returns

+

Returns

the MTU of the device.

@@ -1559,7 +1559,7 @@ nm_device_get_mtu (gboolean nm_device_is_real (NMDevice *device);
-

Parameters

+

Parameters

@@ -1574,7 +1574,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.

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

Whether the device is a software device.

-

Parameters

+

Parameters

@@ -1603,7 +1603,7 @@ nm_device_is_software ( -

Returns

+

Returns

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

@@ -1615,7 +1615,7 @@ is a software device, FALSE if it is a hardware dev nm_device_get_product (NMDevice *device);

Gets the product string of the NMDevice.

-

Parameters

+

Parameters

@@ -1630,7 +1630,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.

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

nm_device_get_vendor (NMDevice *device);

Gets the vendor string of the NMDevice.

-

Parameters

+

Parameters

@@ -1657,7 +1657,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.

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

-

Parameters

+

Parameters

@@ -1685,7 +1685,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.

@@ -1698,7 +1698,7 @@ product name is unknown, this returns the interface name.

nm_device_get_metered (NMDevice *device);

Gets the metered setting of a NMDevice.

-

Parameters

+

Parameters

@@ -1713,7 +1713,7 @@ nm_device_get_metered ( -

Returns

+

Returns

the metered setting.

Since: 1.2

@@ -1725,7 +1725,7 @@ nm_device_get_metered (NMDevice *device);

Gets the list of neighbors discovered through LLDP.

-

Parameters

+

Parameters

@@ -1740,7 +1740,7 @@ nm_device_get_lldp_neighbors ( -

Returns

+

Returns

the GPtrArray containing NMLldpNeighbors. This is the internal copy used by the device and must not be modified. The library never modifies the returned @@ -1759,7 +1759,7 @@ nm_device_disambiguate_names (devices .

-

Parameters

+

Parameters

@@ -1782,7 +1782,7 @@ devices in devices
-

Returns

+

Returns

the device names.

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

@@ -1800,7 +1800,7 @@ nm_device_reapply ( -

Parameters

+

Parameters

@@ -1844,7 +1844,7 @@ catch concurrent accesses.

-

Returns

+

Returns

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

@@ -1864,7 +1864,7 @@ nm_device_reapply_async ( -

Parameters

+

Parameters

@@ -1924,7 +1924,7 @@ nm_device_reapply_finish (GError **error);

Gets the result of a call to nm_device_reapply_async().

-

Parameters

+

Parameters

@@ -1951,7 +1951,7 @@ nm_device_reapply_finish ( -

Returns

+

Returns

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

@@ -1968,7 +1968,7 @@ nm_device_get_applied_connection (GError **error);

Fetch the currently applied connection on the device.

-

Parameters

+

Parameters

@@ -2006,7 +2006,7 @@ the applied connection.

-

Returns

+

Returns

a NMConnection with the currently applied settings or NULL on error.

The connection is as received from D-Bus and might not validate according @@ -2027,7 +2027,7 @@ nm_device_get_applied_connection_async gpointer user_data);

Asynchronously begins an get the a currently applied connection.

-

Parameters

+

Parameters

@@ -2077,7 +2077,7 @@ nm_device_get_applied_connection_finish GError **error);

Gets the result of a call to nm_device_get_applied_connection_async().

-

Parameters

+

Parameters

@@ -2110,7 +2110,7 @@ connection.

-

Returns

+

Returns

a currently applied NMConnection or NULL in case of error.

The connection is as received from D-Bus and might not validate according @@ -2130,7 +2130,7 @@ nm_device_disconnect ( -

Parameters

+

Parameters

@@ -2157,7 +2157,7 @@ request.

-

Returns

+

Returns

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

@@ -2174,7 +2174,7 @@ nm_device_disconnect_async ( -

Parameters

+

Parameters

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

Gets the result of a call to nm_device_disconnect_async().

-

Parameters

+

Parameters

@@ -2243,7 +2243,7 @@ nm_device_disconnect_finish ( -

Returns

+

Returns

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

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

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

-

Parameters

+

Parameters

@@ -2284,7 +2284,7 @@ nm_device_delete ( -

Returns

+

Returns

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

@@ -2300,7 +2300,7 @@ nm_device_delete_async ( -

Parameters

+

Parameters

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

Gets the result of a call to nm_device_delete_async().

-

Parameters

+

Parameters

@@ -2369,7 +2369,7 @@ nm_device_delete_finish ( -

Returns

+

Returns

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

@@ -2391,7 +2391,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

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

connections

an array of NMConnections to filter.

an array of NMConnections to filter.

[element-type NMConnection]
-

Returns

+

Returns

an array of -NMConnections that could be activated with the given device +NMConnections that could be activated with the given device . The array should be freed with g_ptr_array_unref() when it is no longer required.

[transfer container][element-type NMConnection]

@@ -2436,7 +2436,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

@@ -2460,7 +2460,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.

@@ -2484,7 +2484,7 @@ device.

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

-

Parameters

+

Parameters

@@ -2513,7 +2513,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.

@@ -2527,7 +2527,7 @@ nm_device_get_setting_type (device .

-

Parameters

+

Parameters

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

Returns

+

Returns

device 's associated NMSetting type

@@ -2554,7 +2554,7 @@ that can be used on device nm_lldp_neighbor_new (void);

Creates a new NMLldpNeighbor object.

-

Returns

+

Returns

the new NMLldpNeighbor object.

[transfer full]

@@ -2567,7 +2567,7 @@ nm_lldp_neighbor_new (void nm_lldp_neighbor_ref (NMLldpNeighbor *neighbor);

Increases the reference count of the object.

-

Parameters

+

Parameters

@@ -2591,7 +2591,7 @@ nm_lldp_neighbor_unref ( -

Parameters

+

Parameters

@@ -2615,7 +2615,7 @@ nm_lldp_neighbor_get_attr_names (Gets an array of attribute names available for neighbor .

-

Parameters

+

Parameters

@@ -2630,7 +2630,7 @@ nm_lldp_neighbor_get_attr_names (
-

Returns

+

Returns

a NULL-terminated array of attribute names.

[transfer full]

@@ -2648,7 +2648,7 @@ nm_lldp_neighbor_get_attr_string_value on neighbor

-

Parameters

+

Parameters

@@ -2675,7 +2675,7 @@ nm_lldp_neighbor_get_attr_string_value
-

Returns

+

Returns

TRUE if a string attribute with name name was found, FALSE otherwise

@@ -2692,7 +2692,7 @@ nm_lldp_neighbor_get_attr_uint_value (neighbor

-

Parameters

+

Parameters

@@ -2719,7 +2719,7 @@ nm_lldp_neighbor_get_attr_uint_value ( -

Returns

+

Returns

TRUE if a uint attribute with name name was found, FALSE otherwise

@@ -2733,7 +2733,7 @@ nm_lldp_neighbor_get_attr_type (char *name);

Get the type of an attribute.

-

Parameters

+

Parameters

@@ -2755,7 +2755,7 @@ nm_lldp_neighbor_get_attr_type (
-

Returns

+

Returns

the GVariantType of the attribute with name name

@@ -3038,7 +3038,7 @@ operations like addressing and routing.

The “ip4-config” property

  “ip4-config”               NMIPConfig *
-

The NMIP4Config of the device.

+

The NMIP4Config of the device.

Flags: Read


@@ -3168,7 +3168,7 @@ user_function (gpointer user_data)

Notifies the state change of a NMDevice.

-

Parameters

+

Parameters

@@ -3209,6 +3209,6 @@ user_function ( +
Generated by GTK-Doc V1.25 \ No newline at end of file -- cgit 1.3.0-6-gf8a5