diff options
| author | Michael Biebl <biebl@debian.org> | 2015-07-14 19:38:58 +0200 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2015-07-14 19:38:58 +0200 |
| commit | 50a58f0fabd8a34c1b6108a107e08abe3c1ccd24 (patch) | |
| tree | 6790165f39daee79e2b6c6617483320613493367 /docs/libnm/html/NMDevice.html | |
| parent | f408e27bccfacf347605a8d98649975a68f38a17 (diff) | |
Imported Upstream version 1.0.4 upstream/1.0.4
Diffstat (limited to 'docs/libnm/html/NMDevice.html')
| -rw-r--r-- | docs/libnm/html/NMDevice.html | 176 |
1 files changed, 73 insertions, 103 deletions
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 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>libnm Reference Manual: NMDevice</title> +<title>NMDevice: libnm Reference Manual</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="libnm Reference Manual"> <link rel="up" href="ch04.html" title="Device and Runtime Configuration API Reference"> <link rel="prev" href="ch04.html" title="Device and Runtime Configuration API Reference"> <link rel="next" href="NMDeviceAdsl.html" title="NMDeviceAdsl"> -<meta name="generator" content="GTK-Doc V1.21 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -626,8 +626,6 @@ </div> <div class="refsect1"> <a name="NMDevice.description"></a><h2>Description</h2> -<p> -</p> </div> <div class="refsect1"> <a name="NMDevice.functions_details"></a><h2>Functions</h2> @@ -655,7 +653,6 @@ nm_device_get_iface (<em class="parameter"><code><a class="link" href="NMDevice. <a name="id-1.5.2.9.2.6"></a><h4>Returns</h4> <p> the interface of the device. This is the internal string used by the device, and must not be modified.</p> -<p></p> </div> </div> <hr> @@ -684,7 +681,6 @@ when the device is in the ACTIVATED state.</p> <a name="id-1.5.2.9.3.6"></a><h4>Returns</h4> <p> the IP traffic interface of the device. This is the internal string used by the device, and must not be modified.</p> -<p></p> </div> </div> <hr> @@ -711,7 +707,6 @@ nm_device_get_device_type (<em class="parameter"><code><a class="link" href="NMD <div class="refsect3"> <a name="id-1.5.2.9.4.6"></a><h4>Returns</h4> <p> the device type</p> -<p></p> </div> </div> <hr> @@ -740,7 +735,6 @@ nm_device_get_udi (<em class="parameter"><code><a class="link" href="NMDevice.ht <p> 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.</p> -<p></p> </div> </div> <hr> @@ -768,7 +762,6 @@ nm_device_get_driver (<em class="parameter"><code><a class="link" href="NMDevice <a name="id-1.5.2.9.6.6"></a><h4>Returns</h4> <p> the driver of the device. This is the internal string used by the device, and must not be modified.</p> -<p></p> </div> </div> <hr> @@ -796,7 +789,6 @@ nm_device_get_driver_version (<em class="parameter"><code><a class="link" href=" <a name="id-1.5.2.9.7.6"></a><h4>Returns</h4> <p> the version of the device driver. This is the internal string used by the device, and must not be modified.</p> -<p></p> </div> </div> <hr> @@ -824,7 +816,6 @@ nm_device_get_firmware_version (<em class="parameter"><code><a class="link" href <a name="id-1.5.2.9.8.6"></a><h4>Returns</h4> <p> the firmware version of the device. This is the internal string used by the device, and must not be modified.</p> -<p></p> </div> </div> <hr> @@ -854,7 +845,6 @@ nm_device_get_type_description (<em class="parameter"><code><a class="link" href <a name="id-1.5.2.9.9.6"></a><h4>Returns</h4> <p> the type description of the device. This is the internal string used by the device, and must not be modified.</p> -<p></p> </div> </div> <hr> @@ -883,7 +873,6 @@ nm_device_get_hw_address (<em class="parameter"><code><a class="link" href="NMDe <a name="id-1.5.2.9.10.6"></a><h4>Returns</h4> <p> the current MAC of the device, or <code class="literal">NULL</code>. This is the internal string used by the device, and must not be modified.</p> -<p></p> </div> </div> <hr> @@ -910,7 +899,6 @@ nm_device_get_capabilities (<em class="parameter"><code><a class="link" href="NM <div class="refsect3"> <a name="id-1.5.2.9.11.6"></a><h4>Returns</h4> <p> the capabilities</p> -<p></p> </div> </div> <hr> @@ -937,7 +925,6 @@ nm_device_get_managed (<em class="parameter"><code><a class="link" href="NMDevic <div class="refsect3"> <a name="id-1.5.2.9.12.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the device is managed by NetworkManager</p> -<p></p> </div> </div> <hr> @@ -964,7 +951,6 @@ nm_device_get_autoconnect (<em class="parameter"><code><a class="link" href="NMD <div class="refsect3"> <a name="id-1.5.2.9.13.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the device is allowed to be autoconnected</p> -<p></p> </div> </div> <hr> @@ -1023,7 +1009,6 @@ to be missing.</p> <a name="id-1.5.2.9.15.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if firmware required for the device's operation is likely to be missing.</p> -<p></p> </div> </div> <hr> @@ -1169,7 +1154,6 @@ nm_device_get_state (<em class="parameter"><code><a class="link" href="NMDevice. <div class="refsect3"> <a name="id-1.5.2.9.20.6"></a><h4>Returns</h4> <p> the current device state</p> -<p></p> </div> </div> <hr> @@ -1196,7 +1180,6 @@ nm_device_get_state_reason (<em class="parameter"><code><a class="link" href="NM <div class="refsect3"> <a name="id-1.5.2.9.21.6"></a><h4>Returns</h4> <p> the reason for entering the current device state</p> -<p></p> </div> </div> <hr> @@ -1287,7 +1270,6 @@ ports on a single physical port. (Eg, NPAR / SR-IOV.)</p> <p> the physical port ID of the device, or <code class="literal">NULL</code> if the port ID is unknown. This is the internal string used by the device and must not be modified.</p> -<p></p> </div> </div> <hr> @@ -1314,7 +1296,6 @@ nm_device_get_mtu (<em class="parameter"><code><a class="link" href="NMDevice.ht <div class="refsect3"> <a name="id-1.5.2.9.25.6"></a><h4>Returns</h4> <p> the MTU of the device.</p> -<p></p> </div> </div> <hr> @@ -1342,7 +1323,6 @@ nm_device_is_software (<em class="parameter"><code><a class="link" href="NMDevic <a name="id-1.5.2.9.26.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if <em class="parameter"><code>device</code></em> is a software device, <code class="literal">FALSE</code> if it is a hardware device.</p> -<p></p> </div> </div> <hr> @@ -1370,7 +1350,6 @@ nm_device_get_product (<em class="parameter"><code><a class="link" href="NMDevic <a name="id-1.5.2.9.27.6"></a><h4>Returns</h4> <p> the product name of the device. This is the internal string used by the device, and must not be modified.</p> -<p></p> </div> </div> <hr> @@ -1398,7 +1377,6 @@ nm_device_get_vendor (<em class="parameter"><code><a class="link" href="NMDevice <a name="id-1.5.2.9.28.6"></a><h4>Returns</h4> <p> the vendor name of the device. This is the internal string used by the device, and must not be modified.</p> -<p></p> </div> </div> <hr> @@ -1428,7 +1406,6 @@ nm_device_get_description (<em class="parameter"><code><a class="link" href="NMD <p> a description of <em class="parameter"><code>device</code></em> . If either the vendor or the product name is unknown, this returns the interface name.</p> -<p></p> </div> </div> <hr> @@ -1510,7 +1487,6 @@ request.</p> <a name="id-1.5.2.9.31.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on error, in which case <em class="parameter"><code>error</code></em> will be set.</p> -<p></p> </div> </div> <hr> @@ -1597,7 +1573,6 @@ nm_device_disconnect_finish (<em class="parameter"><code><a class="link" href="N <a name="id-1.5.2.9.33.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on error, in which case <em class="parameter"><code>error</code></em> will be set.</p> -<p></p> </div> </div> <hr> @@ -1639,7 +1614,6 @@ nm_device_delete (<em class="parameter"><code><a class="link" href="NMDevice.htm <a name="id-1.5.2.9.34.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on error, in which case <em class="parameter"><code>error</code></em> will be set.</p> -<p></p> </div> </div> <hr> @@ -1725,7 +1699,6 @@ nm_device_delete_finish (<em class="parameter"><code><a class="link" href="NMDev <a name="id-1.5.2.9.36.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on error, in which case <em class="parameter"><code>error</code></em> will be set.</p> -<p></p> </div> </div> <hr> @@ -1817,7 +1790,6 @@ against</p></td> <a name="id-1.5.2.9.38.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the connection may be activated with this device, <code class="literal">FALSE</code> if is incompatible with the device's capabilities and characteristics.</p> -<p></p> </div> </div> <hr> @@ -1871,7 +1843,6 @@ against</p></td> <a name="id-1.5.2.9.39.7"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the connection may be activated with this device, <code class="literal">FALSE</code> if is incompatible with the device's capabilities and characteristics.</p> -<p></p> </div> </div> <hr> @@ -1901,7 +1872,6 @@ that can be used on <em class="parameter"><code>device</code></em> <a name="id-1.5.2.9.40.6"></a><h4>Returns</h4> <p> <em class="parameter"><code>device</code></em> 's associated <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> type</p> -<p></p> </div> </div> </div> @@ -1911,184 +1881,138 @@ that can be used on <em class="parameter"><code>device</code></em> <a name="NM-DEVICE-DEVICE-TYPE:CAPS"></a><h3>NM_DEVICE_DEVICE_TYPE</h3> <pre class="programlisting">#define NM_DEVICE_DEVICE_TYPE "device-type" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-UDI:CAPS"></a><h3>NM_DEVICE_UDI</h3> <pre class="programlisting">#define NM_DEVICE_UDI "udi" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-INTERFACE:CAPS"></a><h3>NM_DEVICE_INTERFACE</h3> <pre class="programlisting">#define NM_DEVICE_INTERFACE "interface" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-IP-INTERFACE:CAPS"></a><h3>NM_DEVICE_IP_INTERFACE</h3> <pre class="programlisting">#define NM_DEVICE_IP_INTERFACE "ip-interface" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-DRIVER:CAPS"></a><h3>NM_DEVICE_DRIVER</h3> <pre class="programlisting">#define NM_DEVICE_DRIVER "driver" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-DRIVER-VERSION:CAPS"></a><h3>NM_DEVICE_DRIVER_VERSION</h3> <pre class="programlisting">#define NM_DEVICE_DRIVER_VERSION "driver-version" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-FIRMWARE-VERSION:CAPS"></a><h3>NM_DEVICE_FIRMWARE_VERSION</h3> <pre class="programlisting">#define NM_DEVICE_FIRMWARE_VERSION "firmware-version" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-CAPABILITIES:CAPS"></a><h3>NM_DEVICE_CAPABILITIES</h3> <pre class="programlisting">#define NM_DEVICE_CAPABILITIES "capabilities" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-MANAGED:CAPS"></a><h3>NM_DEVICE_MANAGED</h3> <pre class="programlisting">#define NM_DEVICE_MANAGED "managed" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-AUTOCONNECT:CAPS"></a><h3>NM_DEVICE_AUTOCONNECT</h3> <pre class="programlisting">#define NM_DEVICE_AUTOCONNECT "autoconnect" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-FIRMWARE-MISSING:CAPS"></a><h3>NM_DEVICE_FIRMWARE_MISSING</h3> <pre class="programlisting">#define NM_DEVICE_FIRMWARE_MISSING "firmware-missing" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-IP4-CONFIG:CAPS"></a><h3>NM_DEVICE_IP4_CONFIG</h3> <pre class="programlisting">#define NM_DEVICE_IP4_CONFIG "ip4-config" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-DHCP4-CONFIG:CAPS"></a><h3>NM_DEVICE_DHCP4_CONFIG</h3> <pre class="programlisting">#define NM_DEVICE_DHCP4_CONFIG "dhcp4-config" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-IP6-CONFIG:CAPS"></a><h3>NM_DEVICE_IP6_CONFIG</h3> <pre class="programlisting">#define NM_DEVICE_IP6_CONFIG "ip6-config" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-DHCP6-CONFIG:CAPS"></a><h3>NM_DEVICE_DHCP6_CONFIG</h3> <pre class="programlisting">#define NM_DEVICE_DHCP6_CONFIG "dhcp6-config" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-STATE:CAPS"></a><h3>NM_DEVICE_STATE</h3> <pre class="programlisting">#define NM_DEVICE_STATE "state" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-STATE-REASON:CAPS"></a><h3>NM_DEVICE_STATE_REASON</h3> <pre class="programlisting">#define NM_DEVICE_STATE_REASON "state-reason" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-ACTIVE-CONNECTION:CAPS"></a><h3>NM_DEVICE_ACTIVE_CONNECTION</h3> <pre class="programlisting">#define NM_DEVICE_ACTIVE_CONNECTION "active-connection" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-AVAILABLE-CONNECTIONS:CAPS"></a><h3>NM_DEVICE_AVAILABLE_CONNECTIONS</h3> <pre class="programlisting">#define NM_DEVICE_AVAILABLE_CONNECTIONS "available-connections" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-VENDOR:CAPS"></a><h3>NM_DEVICE_VENDOR</h3> <pre class="programlisting">#define NM_DEVICE_VENDOR "vendor" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-PRODUCT:CAPS"></a><h3>NM_DEVICE_PRODUCT</h3> <pre class="programlisting">#define NM_DEVICE_PRODUCT "product" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-PHYSICAL-PORT-ID:CAPS"></a><h3>NM_DEVICE_PHYSICAL_PORT_ID</h3> <pre class="programlisting">#define NM_DEVICE_PHYSICAL_PORT_ID "physical-port-id" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-DEVICE-MTU:CAPS"></a><h3>NM_DEVICE_MTU</h3> <pre class="programlisting">#define NM_DEVICE_MTU "mtu" </pre> -<p> -</p> </div> </div> <div class="refsect1"> @@ -2096,14 +2020,14 @@ that can be used on <em class="parameter"><code>device</code></em> <div class="refsect2"> <a name="NMDevice--active-connection"></a><h3>The <code class="literal">“active-connection”</code> property</h3> <pre class="programlisting"> “active-connection” <a class="link" href="NMActiveConnection.html" title="NMActiveConnection"><span class="type">NMActiveConnection</span></a> *</pre> -<p></p> +<p>The <a class="link" href="NMActiveConnection.html" title="NMActiveConnection"><span class="type">NMActiveConnection</span></a> object that "owns" this device during activation.</p> <p>Flags: Read</p> </div> <hr> <div class="refsect2"> <a name="NMDevice--autoconnect"></a><h3>The <code class="literal">“autoconnect”</code> property</h3> <pre class="programlisting"> “autoconnect” <span class="type">gboolean</span></pre> -<p></p> +<p>Whether the device can auto-activate a connection.</p> <p>Flags: Read / Write</p> <p>Default value: TRUE</p> </div> @@ -2111,21 +2035,22 @@ that can be used on <em class="parameter"><code>device</code></em> <div class="refsect2"> <a name="NMDevice--available-connections"></a><h3>The <code class="literal">“available-connections”</code> property</h3> <pre class="programlisting"> “available-connections” <span class="type">GPtrArray</span> *</pre> -<p></p> +<p>The available connections of the device</p> +<p>Element-type: NMRemoteConnection</p> <p>Flags: Read</p> </div> <hr> <div class="refsect2"> <a name="NMDevice--capabilities"></a><h3>The <code class="literal">“capabilities”</code> property</h3> <pre class="programlisting"> “capabilities” <a class="link" href="libnm-nm-dbus-interface.html#NMDeviceCapabilities" title="enum NMDeviceCapabilities"><span class="type">NMDeviceCapabilities</span></a></pre> -<p></p> +<p>The capabilities of the device.</p> <p>Flags: Read</p> </div> <hr> <div class="refsect2"> <a name="NMDevice--device-type"></a><h3>The <code class="literal">“device-type”</code> property</h3> <pre class="programlisting"> “device-type” <a class="link" href="libnm-nm-dbus-interface.html#NMDeviceType" title="enum NMDeviceType"><span class="type">NMDeviceType</span></a></pre> -<p></p> +<p>The numeric type of the device.</p> <p>Flags: Read</p> <p>Default value: NM_DEVICE_TYPE_UNKNOWN</p> </div> @@ -2133,21 +2058,21 @@ that can be used on <em class="parameter"><code>device</code></em> <div class="refsect2"> <a name="NMDevice--dhcp4-config"></a><h3>The <code class="literal">“dhcp4-config”</code> property</h3> <pre class="programlisting"> “dhcp4-config” <a class="link" href="NMDhcpConfig.html" title="NMDhcpConfig"><span class="type">NMDhcpConfig</span></a> *</pre> -<p></p> +<p>The IPv4 <a class="link" href="NMDhcpConfig.html" title="NMDhcpConfig"><span class="type">NMDhcpConfig</span></a> of the device.</p> <p>Flags: Read</p> </div> <hr> <div class="refsect2"> <a name="NMDevice--dhcp6-config"></a><h3>The <code class="literal">“dhcp6-config”</code> property</h3> <pre class="programlisting"> “dhcp6-config” <a class="link" href="NMDhcpConfig.html" title="NMDhcpConfig"><span class="type">NMDhcpConfig</span></a> *</pre> -<p></p> +<p>The IPv6 <a class="link" href="NMDhcpConfig.html" title="NMDhcpConfig"><span class="type">NMDhcpConfig</span></a> of the device.</p> <p>Flags: Read</p> </div> <hr> <div class="refsect2"> <a name="NMDevice--driver"></a><h3>The <code class="literal">“driver”</code> property</h3> <pre class="programlisting"> “driver” <span class="type">gchar</span> *</pre> -<p></p> +<p>The driver of the device.</p> <p>Flags: Read</p> <p>Default value: NULL</p> </div> @@ -2155,7 +2080,7 @@ that can be used on <em class="parameter"><code>device</code></em> <div class="refsect2"> <a name="NMDevice--driver-version"></a><h3>The <code class="literal">“driver-version”</code> property</h3> <pre class="programlisting"> “driver-version” <span class="type">gchar</span> *</pre> -<p></p> +<p>The version of the device driver.</p> <p>Flags: Read</p> <p>Default value: NULL</p> </div> @@ -2163,7 +2088,8 @@ that can be used on <em class="parameter"><code>device</code></em> <div class="refsect2"> <a name="NMDevice--firmware-missing"></a><h3>The <code class="literal">“firmware-missing”</code> property</h3> <pre class="programlisting"> “firmware-missing” <span class="type">gboolean</span></pre> -<p></p> +<p>When <code class="literal">TRUE</code> indicates the device is likely missing firmware required +for its operation.</p> <p>Flags: Read</p> <p>Default value: FALSE</p> </div> @@ -2171,7 +2097,7 @@ that can be used on <em class="parameter"><code>device</code></em> <div class="refsect2"> <a name="NMDevice--firmware-version"></a><h3>The <code class="literal">“firmware-version”</code> property</h3> <pre class="programlisting"> “firmware-version” <span class="type">gchar</span> *</pre> -<p></p> +<p>The firmware version of the device.</p> <p>Flags: Read</p> <p>Default value: NULL</p> </div> @@ -2179,7 +2105,7 @@ that can be used on <em class="parameter"><code>device</code></em> <div class="refsect2"> <a name="NMDevice--interface"></a><h3>The <code class="literal">“interface”</code> property</h3> <pre class="programlisting"> “interface” <span class="type">gchar</span> *</pre> -<p></p> +<p>The interface of the device.</p> <p>Flags: Read</p> <p>Default value: NULL</p> </div> @@ -2187,7 +2113,8 @@ that can be used on <em class="parameter"><code>device</code></em> <div class="refsect2"> <a name="NMDevice--ip-interface"></a><h3>The <code class="literal">“ip-interface”</code> property</h3> <pre class="programlisting"> “ip-interface” <span class="type">gchar</span> *</pre> -<p></p> +<p>The IP interface of the device which should be used for all IP-related +operations like addressing and routing.</p> <p>Flags: Read</p> <p>Default value: NULL</p> </div> @@ -2195,21 +2122,21 @@ that can be used on <em class="parameter"><code>device</code></em> <div class="refsect2"> <a name="NMDevice--ip4-config"></a><h3>The <code class="literal">“ip4-config”</code> property</h3> <pre class="programlisting"> “ip4-config” <a class="link" href="NMIPConfig.html" title="NMIPConfig"><span class="type">NMIPConfig</span></a> *</pre> -<p></p> +<p>The <a href="https://developer.gnome.org/libnm-glib/0.9/NMIP4Config.html"><span class="type">NMIP4Config</span></a> of the device.</p> <p>Flags: Read</p> </div> <hr> <div class="refsect2"> <a name="NMDevice--ip6-config"></a><h3>The <code class="literal">“ip6-config”</code> property</h3> <pre class="programlisting"> “ip6-config” <a class="link" href="NMIPConfig.html" title="NMIPConfig"><span class="type">NMIPConfig</span></a> *</pre> -<p></p> +<p>The IPv6 <a class="link" href="NMIPConfig.html" title="NMIPConfig"><span class="type">NMIPConfig</span></a> of the device.</p> <p>Flags: Read</p> </div> <hr> <div class="refsect2"> <a name="NMDevice--managed"></a><h3>The <code class="literal">“managed”</code> property</h3> <pre class="programlisting"> “managed” <span class="type">gboolean</span></pre> -<p></p> +<p>Whether the device is managed by NetworkManager.</p> <p>Flags: Read</p> <p>Default value: FALSE</p> </div> @@ -2217,7 +2144,7 @@ that can be used on <em class="parameter"><code>device</code></em> <div class="refsect2"> <a name="NMDevice--mtu"></a><h3>The <code class="literal">“mtu”</code> property</h3> <pre class="programlisting"> “mtu” <span class="type">guint</span></pre> -<p></p> +<p>The MTU of the device.</p> <p>Flags: Read</p> <p>Default value: 1500</p> </div> @@ -2225,7 +2152,8 @@ that can be used on <em class="parameter"><code>device</code></em> <div class="refsect2"> <a name="NMDevice--physical-port-id"></a><h3>The <code class="literal">“physical-port-id”</code> property</h3> <pre class="programlisting"> “physical-port-id” <span class="type">gchar</span> *</pre> -<p></p> +<p>The physical port ID of the device. (See +<a class="link" href="NMDevice.html#nm-device-get-physical-port-id" title="nm_device_get_physical_port_id ()"><code class="function">nm_device_get_physical_port_id()</code></a>.)</p> <p>Flags: Read</p> <p>Default value: NULL</p> </div> @@ -2233,7 +2161,7 @@ that can be used on <em class="parameter"><code>device</code></em> <div class="refsect2"> <a name="NMDevice--product"></a><h3>The <code class="literal">“product”</code> property</h3> <pre class="programlisting"> “product” <span class="type">gchar</span> *</pre> -<p></p> +<p>The product string of the device.</p> <p>Flags: Read</p> <p>Default value: NULL</p> </div> @@ -2241,7 +2169,7 @@ that can be used on <em class="parameter"><code>device</code></em> <div class="refsect2"> <a name="NMDevice--state"></a><h3>The <code class="literal">“state”</code> property</h3> <pre class="programlisting"> “state” <a class="link" href="libnm-nm-dbus-interface.html#NMDeviceState" title="enum NMDeviceState"><span class="type">NMDeviceState</span></a></pre> -<p></p> +<p>The state of the device.</p> <p>Flags: Read</p> <p>Default value: NM_DEVICE_STATE_UNKNOWN</p> </div> @@ -2249,7 +2177,7 @@ that can be used on <em class="parameter"><code>device</code></em> <div class="refsect2"> <a name="NMDevice--state-reason"></a><h3>The <code class="literal">“state-reason”</code> property</h3> <pre class="programlisting"> “state-reason” <span class="type">guint</span></pre> -<p></p> +<p>The reason for the device state.</p> <p>Flags: Read</p> <p>Default value: 0</p> </div> @@ -2257,7 +2185,12 @@ that can be used on <em class="parameter"><code>device</code></em> <div class="refsect2"> <a name="NMDevice--udi"></a><h3>The <code class="literal">“udi”</code> property</h3> <pre class="programlisting"> “udi” <span class="type">gchar</span> *</pre> -<p></p> +<p>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.</p> <p>Flags: Read</p> <p>Default value: NULL</p> </div> @@ -2265,7 +2198,7 @@ that can be used on <em class="parameter"><code>device</code></em> <div class="refsect2"> <a name="NMDevice--vendor"></a><h3>The <code class="literal">“vendor”</code> property</h3> <pre class="programlisting"> “vendor” <span class="type">gchar</span> *</pre> -<p></p> +<p>The vendor string of the device.</p> <p>Flags: Read</p> <p>Default value: NULL</p> </div> @@ -2280,12 +2213,49 @@ user_function (<a class="link" href="NMDevice.html" title="NMDevice"><span class <span class="type">guint</span> old_state, <span class="type">guint</span> reason, <span class="type">gpointer</span> user_data)</pre> +<p>Notifies the state change of a <a class="link" href="NMDevice.html" title="NMDevice"><span class="type">NMDevice</span></a>.</p> +<div class="refsect3"> +<a name="id-1.5.2.12.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>device</p></td> +<td class="parameter_description"><p>the device object that received the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>new_state</p></td> +<td class="parameter_description"><p>the new state of the device</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>old_state</p></td> +<td class="parameter_description"><p>the previous state of the device</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>reason</p></td> +<td class="parameter_description"><p>the reason describing the state change</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> <p>Flags: Run First</p> </div> </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.21</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html> \ No newline at end of file |