From 50a58f0fabd8a34c1b6108a107e08abe3c1ccd24 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 14 Jul 2015 19:38:58 +0200 Subject: Imported Upstream version 1.0.4 --- docs/libnm/html/NMDevice.html | 176 ++++++++++++++++++------------------------ 1 file changed, 73 insertions(+), 103 deletions(-) (limited to 'docs/libnm/html/NMDevice.html') diff --git a/docs/libnm/html/NMDevice.html b/docs/libnm/html/NMDevice.html index 13cae2db..8065247c 100644 --- a/docs/libnm/html/NMDevice.html +++ b/docs/libnm/html/NMDevice.html @@ -2,13 +2,13 @@ -libnm Reference Manual: NMDevice +NMDevice: libnm Reference Manual - + @@ -626,8 +626,6 @@

Description

-

-

Functions

@@ -655,7 +653,6 @@ nm_device_get_iface (

Returns

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

-

@@ -684,7 +681,6 @@ when the device is in the ACTIVATED state.

Returns

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

-

@@ -711,7 +707,6 @@ nm_device_get_device_type (

Returns

the device type

-

@@ -740,7 +735,6 @@ nm_device_get_udi (

Returns

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

-

@@ -796,7 +789,6 @@ nm_device_get_driver_version (

Returns

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

-

@@ -824,7 +816,6 @@ nm_device_get_firmware_version (

Returns

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

-

@@ -854,7 +845,6 @@ nm_device_get_type_description (

Returns

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

-

@@ -883,7 +873,6 @@ nm_device_get_hw_address (

Returns

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

-

@@ -910,7 +899,6 @@ nm_device_get_capabilities (

Returns

the capabilities

-

@@ -937,7 +925,6 @@ nm_device_get_managed (

Returns

TRUE if the device is managed by NetworkManager

-

@@ -964,7 +951,6 @@ nm_device_get_autoconnect (

Returns

TRUE if the device is allowed to be autoconnected

-

@@ -1023,7 +1009,6 @@ to be missing.

Returns

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

-

@@ -1169,7 +1154,6 @@ nm_device_get_state (

Returns

the current device state

-

@@ -1196,7 +1180,6 @@ nm_device_get_state_reason (

Returns

the reason for entering the current device state

-

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

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.

-

@@ -1314,7 +1296,6 @@ nm_device_get_mtu (

Returns

the MTU of the device.

-

@@ -1342,7 +1323,6 @@ nm_device_is_software (

Returns

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

-

@@ -1370,7 +1350,6 @@ nm_device_get_product (

Returns

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

-

@@ -1398,7 +1377,6 @@ nm_device_get_vendor (

Returns

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

-

@@ -1428,7 +1406,6 @@ nm_device_get_description (device . If either the vendor or the product name is unknown, this returns the interface name.

-

@@ -1510,7 +1487,6 @@ request.

Returns

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

-

@@ -1597,7 +1573,6 @@ nm_device_disconnect_finish (

Returns

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

-

@@ -1639,7 +1614,6 @@ nm_device_delete (

Returns

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

-

@@ -1725,7 +1699,6 @@ nm_device_delete_finish (

Returns

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

-

@@ -1817,7 +1790,6 @@ against

Returns

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

-

@@ -1871,7 +1843,6 @@ against

Returns

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

-

@@ -1901,7 +1872,6 @@ that can be used on device

Returns

device 's associated NMSetting type

-

@@ -1911,184 +1881,138 @@ that can be used on device

NM_DEVICE_DEVICE_TYPE

#define NM_DEVICE_DEVICE_TYPE "device-type"
-

-

NM_DEVICE_UDI

#define NM_DEVICE_UDI "udi"
-

-

NM_DEVICE_INTERFACE

#define NM_DEVICE_INTERFACE "interface"
-

-

NM_DEVICE_IP_INTERFACE

#define NM_DEVICE_IP_INTERFACE "ip-interface"
-

-

NM_DEVICE_DRIVER

#define NM_DEVICE_DRIVER "driver"
-

-

NM_DEVICE_DRIVER_VERSION

#define NM_DEVICE_DRIVER_VERSION "driver-version"
-

-

NM_DEVICE_FIRMWARE_VERSION

#define NM_DEVICE_FIRMWARE_VERSION "firmware-version"
-

-

NM_DEVICE_CAPABILITIES

#define NM_DEVICE_CAPABILITIES "capabilities"
-

-

NM_DEVICE_MANAGED

#define NM_DEVICE_MANAGED "managed"
-

-

NM_DEVICE_AUTOCONNECT

#define NM_DEVICE_AUTOCONNECT "autoconnect"
-

-

NM_DEVICE_FIRMWARE_MISSING

#define NM_DEVICE_FIRMWARE_MISSING "firmware-missing"
-

-

NM_DEVICE_IP4_CONFIG

#define NM_DEVICE_IP4_CONFIG "ip4-config"
-

-

NM_DEVICE_DHCP4_CONFIG

#define NM_DEVICE_DHCP4_CONFIG "dhcp4-config"
-

-

NM_DEVICE_IP6_CONFIG

#define NM_DEVICE_IP6_CONFIG "ip6-config"
-

-

NM_DEVICE_DHCP6_CONFIG

#define NM_DEVICE_DHCP6_CONFIG "dhcp6-config"
-

-

NM_DEVICE_STATE

#define NM_DEVICE_STATE "state"
-

-

NM_DEVICE_STATE_REASON

#define NM_DEVICE_STATE_REASON "state-reason"
-

-

NM_DEVICE_ACTIVE_CONNECTION

#define NM_DEVICE_ACTIVE_CONNECTION "active-connection"
-

-

NM_DEVICE_AVAILABLE_CONNECTIONS

#define NM_DEVICE_AVAILABLE_CONNECTIONS "available-connections"
-

-

NM_DEVICE_VENDOR

#define NM_DEVICE_VENDOR "vendor"
-

-

NM_DEVICE_PRODUCT

#define NM_DEVICE_PRODUCT "product"
-

-

NM_DEVICE_PHYSICAL_PORT_ID

#define NM_DEVICE_PHYSICAL_PORT_ID "physical-port-id"
-

-

NM_DEVICE_MTU

#define NM_DEVICE_MTU "mtu"
-

-

@@ -2096,14 +2020,14 @@ that can be used on device

The “active-connection” property

  “active-connection”        NMActiveConnection *
-

+

The NMActiveConnection object that "owns" this device during activation.

Flags: Read

The “autoconnect” property

  “autoconnect”              gboolean
-

+

Whether the device can auto-activate a connection.

Flags: Read / Write

Default value: TRUE

@@ -2111,21 +2035,22 @@ that can be used on device

The “available-connections” property

  “available-connections”    GPtrArray *
-

+

The available connections of the device

+

Element-type: NMRemoteConnection

Flags: Read

The “capabilities” property

  “capabilities”             NMDeviceCapabilities
-

+

The capabilities of the device.

Flags: Read

The “device-type” property

  “device-type”              NMDeviceType
-

+

The numeric type of the device.

Flags: Read

Default value: NM_DEVICE_TYPE_UNKNOWN

@@ -2133,21 +2058,21 @@ that can be used on device

The “dhcp4-config” property

  “dhcp4-config”             NMDhcpConfig *
-

+

The IPv4 NMDhcpConfig of the device.

Flags: Read

The “dhcp6-config” property

  “dhcp6-config”             NMDhcpConfig *
-

+

The IPv6 NMDhcpConfig of the device.

Flags: Read

The “driver” property

  “driver”                   gchar *
-

+

The driver of the device.

Flags: Read

Default value: NULL

@@ -2155,7 +2080,7 @@ that can be used on device

The “driver-version” property

  “driver-version”           gchar *
-

+

The version of the device driver.

Flags: Read

Default value: NULL

@@ -2163,7 +2088,8 @@ that can be used on device

The “firmware-missing” property

  “firmware-missing”         gboolean
-

+

When TRUE indicates the device is likely missing firmware required +for its operation.

Flags: Read

Default value: FALSE

@@ -2171,7 +2097,7 @@ that can be used on device

The “firmware-version” property

  “firmware-version”         gchar *
-

+

The firmware version of the device.

Flags: Read

Default value: NULL

@@ -2179,7 +2105,7 @@ that can be used on device

The “interface” property

  “interface”                gchar *
-

+

The interface of the device.

Flags: Read

Default value: NULL

@@ -2187,7 +2113,8 @@ that can be used on device

The “ip-interface” property

  “ip-interface”             gchar *
-

+

The IP interface of the device which should be used for all IP-related +operations like addressing and routing.

Flags: Read

Default value: NULL

@@ -2195,21 +2122,21 @@ that can be used on device

The “ip4-config” property

  “ip4-config”               NMIPConfig *
-

+

The NMIP4Config of the device.

Flags: Read

The “ip6-config” property

  “ip6-config”               NMIPConfig *
-

+

The IPv6 NMIPConfig of the device.

Flags: Read

The “managed” property

  “managed”                  gboolean
-

+

Whether the device is managed by NetworkManager.

Flags: Read

Default value: FALSE

@@ -2217,7 +2144,7 @@ that can be used on device

The “mtu” property

  “mtu”                      guint
-

+

The MTU of the device.

Flags: Read

Default value: 1500

@@ -2225,7 +2152,8 @@ that can be used on device

The “physical-port-id” property

  “physical-port-id”         gchar *
-

+

The physical port ID of the device. (See +nm_device_get_physical_port_id().)

Flags: Read

Default value: NULL

@@ -2233,7 +2161,7 @@ that can be used on device

The “product” property

  “product”                  gchar *
-

+

The product string of the device.

Flags: Read

Default value: NULL

@@ -2241,7 +2169,7 @@ that can be used on device

The “state” property

  “state”                    NMDeviceState
-

+

The state of the device.

Flags: Read

Default value: NM_DEVICE_STATE_UNKNOWN

@@ -2249,7 +2177,7 @@ that can be used on device

The “state-reason” property

  “state-reason”             guint
-

+

The reason for the device state.

Flags: Read

Default value: 0

@@ -2257,7 +2185,12 @@ that can be used on device

The “udi” property

  “udi”                      gchar *
-

+

An operating-system specific device hardware identifier; this is not +unique to a specific hardware device across reboots or hotplugs. It +is an opaque string which for some device types (Bluetooth, Modem) +contains an identifier provided by the underlying hardware service daemon +such as Bluez or ModemManager, and clients can use this property to +request more information about the device from those services.

Flags: Read

Default value: NULL

@@ -2265,7 +2198,7 @@ that can be used on device

The “vendor” property

  “vendor”                   gchar *
-

+

The vendor string of the device.

Flags: Read

Default value: NULL

@@ -2280,12 +2213,49 @@ user_function (guint old_state, guint reason, gpointer user_data) +

Notifies the state change of a NMDevice.

+
+

Parameters

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

device

the device object that received the signal

 

new_state

the new state of the device

 

old_state

the previous state of the device

 

reason

the reason describing the state change

 

user_data

user data set when the signal handler was connected.

 
+

Flags: Run First

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