diff options
Diffstat (limited to 'docs/libnm-glib/html/libnm-glib-nm-device.html')
| -rw-r--r-- | docs/libnm-glib/html/libnm-glib-nm-device.html | 743 |
1 files changed, 743 insertions, 0 deletions
diff --git a/docs/libnm-glib/html/libnm-glib-nm-device.html b/docs/libnm-glib/html/libnm-glib-nm-device.html new file mode 100644 index 00000000..d37903e1 --- /dev/null +++ b/docs/libnm-glib/html/libnm-glib-nm-device.html @@ -0,0 +1,743 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>NMDevice</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="libnm-glib Reference Manual"> +<link rel="up" href="ch01.html" title="libnm-glib Objects"> +<link rel="prev" href="libnm-glib-nm-active-connection.html" title="NMActiveConnection"> +<link rel="next" href="libnm-glib-nm-device-ethernet.html" title="NMDeviceEthernet"> +<meta name="generator" content="GTK-Doc V1.14 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="libnm-glib-nm-active-connection.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">libnm-glib Reference Manual</th> +<td><a accesskey="n" href="libnm-glib-nm-device-ethernet.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#libnm-glib-nm-device.synopsis" class="shortcut">Top</a> + | + <a href="#libnm-glib-nm-device.description" class="shortcut">Description</a> + | + <a href="#libnm-glib-nm-device.object-hierarchy" class="shortcut">Object Hierarchy</a> + | + <a href="#libnm-glib-nm-device.properties" class="shortcut">Properties</a> + | + <a href="#libnm-glib-nm-device.signals" class="shortcut">Signals</a> +</td></tr> +</table> +<div class="refentry" title="NMDevice"> +<a name="libnm-glib-nm-device"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libnm-glib-nm-device.top_of_page"></a>NMDevice</span></h2> +<p>NMDevice</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv" title="Synopsis"> +<a name="libnm-glib-nm-device.synopsis"></a><h2>Synopsis</h2> +<a name="NMDevice"></a><pre class="synopsis">#define <a class="link" href="libnm-glib-nm-device.html#NM-DEVICE-UDI:CAPS" title="NM_DEVICE_UDI">NM_DEVICE_UDI</a> +#define <a class="link" href="libnm-glib-nm-device.html#NM-DEVICE-INTERFACE:CAPS" title="NM_DEVICE_INTERFACE">NM_DEVICE_INTERFACE</a> +#define <a class="link" href="libnm-glib-nm-device.html#NM-DEVICE-DRIVER:CAPS" title="NM_DEVICE_DRIVER">NM_DEVICE_DRIVER</a> +#define <a class="link" href="libnm-glib-nm-device.html#NM-DEVICE-CAPABILITIES:CAPS" title="NM_DEVICE_CAPABILITIES">NM_DEVICE_CAPABILITIES</a> +#define <a class="link" href="libnm-glib-nm-device.html#NM-DEVICE-MANAGED:CAPS" title="NM_DEVICE_MANAGED">NM_DEVICE_MANAGED</a> +#define <a class="link" href="libnm-glib-nm-device.html#NM-DEVICE-IP4-CONFIG:CAPS" title="NM_DEVICE_IP4_CONFIG">NM_DEVICE_IP4_CONFIG</a> +#define <a class="link" href="libnm-glib-nm-device.html#NM-DEVICE-DHCP4-CONFIG:CAPS" title="NM_DEVICE_DHCP4_CONFIG">NM_DEVICE_DHCP4_CONFIG</a> +#define <a class="link" href="libnm-glib-nm-device.html#NM-DEVICE-IP6-CONFIG:CAPS" title="NM_DEVICE_IP6_CONFIG">NM_DEVICE_IP6_CONFIG</a> +#define <a class="link" href="libnm-glib-nm-device.html#NM-DEVICE-DHCP6-CONFIG:CAPS" title="NM_DEVICE_DHCP6_CONFIG">NM_DEVICE_DHCP6_CONFIG</a> +#define <a class="link" href="libnm-glib-nm-device.html#NM-DEVICE-STATE:CAPS" title="NM_DEVICE_STATE">NM_DEVICE_STATE</a> +#define <a class="link" href="libnm-glib-nm-device.html#NM-DEVICE-VENDOR:CAPS" title="NM_DEVICE_VENDOR">NM_DEVICE_VENDOR</a> +#define <a class="link" href="libnm-glib-nm-device.html#NM-DEVICE-PRODUCT:CAPS" title="NM_DEVICE_PRODUCT">NM_DEVICE_PRODUCT</a> + <a class="link" href="libnm-glib-nm-device.html#NMDevice-struct" title="NMDevice">NMDevice</a>; +<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * <a class="link" href="libnm-glib-nm-device.html#nm-device-new" title="nm_device_new ()">nm_device_new</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> *connection</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *path</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="libnm-glib-nm-device.html#nm-device-get-iface" title="nm_device_get_iface ()">nm_device_get_iface</a> (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="libnm-glib-nm-device.html#nm-device-get-udi" title="nm_device_get_udi ()">nm_device_get_udi</a> (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="libnm-glib-nm-device.html#nm-device-get-driver" title="nm_device_get_driver ()">nm_device_get_driver</a> (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>); +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> <a class="link" href="libnm-glib-nm-device.html#nm-device-get-capabilities" title="nm_device_get_capabilities ()">nm_device_get_capabilities</a> (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>); +<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libnm-glib-nm-device.html#nm-device-get-managed" title="nm_device_get_managed ()">nm_device_get_managed</a> (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>); +<a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="returnvalue">NMIP4Config</span></a> * <a class="link" href="libnm-glib-nm-device.html#nm-device-get-ip4-config" title="nm_device_get_ip4_config ()">nm_device_get_ip4_config</a> (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>); +<a class="link" href="NMDHCP4Config.html" title="NMDHCP4Config"><span class="returnvalue">NMDHCP4Config</span></a> * <a class="link" href="libnm-glib-nm-device.html#nm-device-get-dhcp4-config" title="nm_device_get_dhcp4_config ()">nm_device_get_dhcp4_config</a> (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>); +<a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="returnvalue">NMIP6Config</span></a> * <a class="link" href="libnm-glib-nm-device.html#nm-device-get-ip6-config" title="nm_device_get_ip6_config ()">nm_device_get_ip6_config</a> (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>); +<a class="link" href="NMDHCP6Config.html" title="NMDHCP6Config"><span class="returnvalue">NMDHCP6Config</span></a> * <a class="link" href="libnm-glib-nm-device.html#nm-device-get-dhcp6-config" title="nm_device_get_dhcp6_config ()">nm_device_get_dhcp6_config</a> (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>); +<span class="returnvalue">NMDeviceState</span> <a class="link" href="libnm-glib-nm-device.html#nm-device-get-state" title="nm_device_get_state ()">nm_device_get_state</a> (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="libnm-glib-nm-device.html#nm-device-get-product" title="nm_device_get_product ()">nm_device_get_product</a> (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="libnm-glib-nm-device.html#nm-device-get-vendor" title="nm_device_get_vendor ()">nm_device_get_vendor</a> (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>); +<span class="returnvalue">void</span> (<a class="link" href="libnm-glib-nm-device.html#NMDeviceDeactivateFn" title="NMDeviceDeactivateFn ()">*NMDeviceDeactivateFn</a>) (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>); +<span class="returnvalue">void</span> <a class="link" href="libnm-glib-nm-device.html#nm-device-disconnect" title="nm_device_disconnect ()">nm_device_disconnect</a> (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>, + <em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDeviceDeactivateFn" title="NMDeviceDeactivateFn ()"><span class="type">NMDeviceDeactivateFn</span></a> callback</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>); +</pre> +</div> +<div class="refsect1" title="Object Hierarchy"> +<a name="libnm-glib-nm-device.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> + +----<a class="link" href="libnm-glib-nm-object.html#NMObject">NMObject</a> + +----NMDevice + +----<a class="link" href="libnm-glib-nm-device-ethernet.html#NMDeviceEthernet">NMDeviceEthernet</a> + +----<a class="link" href="libnm-glib-nm-device-wifi.html#NMDeviceWifi">NMDeviceWifi</a> + +----<a class="link" href="NMSerialDevice.html" title="NMSerialDevice">NMSerialDevice</a> +</pre> +</div> +<div class="refsect1" title="Properties"> +<a name="libnm-glib-nm-device.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="libnm-glib-nm-device.html#NMDevice--capabilities" title='The "capabilities" property'>capabilities</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read + "<a class="link" href="libnm-glib-nm-device.html#NMDevice--dhcp4-config" title='The "dhcp4-config" property'>dhcp4-config</a>" <a class="link" href="NMDHCP4Config.html" title="NMDHCP4Config"><span class="type">NMDHCP4Config</span></a>* : Read + "<a class="link" href="libnm-glib-nm-device.html#NMDevice--dhcp6-config" title='The "dhcp6-config" property'>dhcp6-config</a>" <a class="link" href="NMDHCP6Config.html" title="NMDHCP6Config"><span class="type">NMDHCP6Config</span></a>* : Read + "<a class="link" href="libnm-glib-nm-device.html#NMDevice--driver" title='The "driver" property'>driver</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read + "<a class="link" href="libnm-glib-nm-device.html#NMDevice--interface" title='The "interface" property'>interface</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read + "<a class="link" href="libnm-glib-nm-device.html#NMDevice--ip4-config" title='The "ip4-config" property'>ip4-config</a>" <a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a>* : Read + "<a class="link" href="libnm-glib-nm-device.html#NMDevice--ip6-config" title='The "ip6-config" property'>ip6-config</a>" <a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a>* : Read + "<a class="link" href="libnm-glib-nm-device.html#NMDevice--managed" title='The "managed" property'>managed</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read + "<a class="link" href="libnm-glib-nm-device.html#NMDevice--product" title='The "product" property'>product</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read + "<a class="link" href="libnm-glib-nm-device.html#NMDevice--state" title='The "state" property'>state</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read + "<a class="link" href="libnm-glib-nm-device.html#NMDevice--udi" title='The "udi" property'>udi</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read + "<a class="link" href="libnm-glib-nm-device.html#NMDevice--vendor" title='The "vendor" property'>vendor</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read +</pre> +</div> +<div class="refsect1" title="Signals"> +<a name="libnm-glib-nm-device.signals"></a><h2>Signals</h2> +<pre class="synopsis"> + "<a class="link" href="libnm-glib-nm-device.html#NMDevice-state-changed" title='The "state-changed" signal'>state-changed</a>" : Run First +</pre> +</div> +<div class="refsect1" title="Description"> +<a name="libnm-glib-nm-device.description"></a><h2>Description</h2> +<p> +</p> +</div> +<div class="refsect1" title="Details"> +<a name="libnm-glib-nm-device.details"></a><h2>Details</h2> +<div class="refsect2" title="NM_DEVICE_UDI"> +<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" title="NM_DEVICE_INTERFACE"> +<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" title="NM_DEVICE_DRIVER"> +<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" title="NM_DEVICE_CAPABILITIES"> +<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" title="NM_DEVICE_MANAGED"> +<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" title="NM_DEVICE_IP4_CONFIG"> +<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" title="NM_DEVICE_DHCP4_CONFIG"> +<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" title="NM_DEVICE_IP6_CONFIG"> +<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" title="NM_DEVICE_DHCP6_CONFIG"> +<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" title="NM_DEVICE_STATE"> +<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" title="NM_DEVICE_VENDOR"> +<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" title="NM_DEVICE_PRODUCT"> +<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" title="NMDevice"> +<a name="NMDevice-struct"></a><h3>NMDevice</h3> +<pre class="programlisting">typedef struct _NMDevice NMDevice;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="nm_device_new ()"> +<a name="nm-device-new"></a><h3>nm_device_new ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * nm_device_new (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> *connection</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *path</code></em>);</pre> +<p> +Creates a new <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> +<td>the <a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td> +<td>the DBus object path of the device +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> a new device +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_device_get_iface ()"> +<a name="nm-device-get-iface"></a><h3>nm_device_get_iface ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_device_get_iface (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>);</pre> +<p> +Gets the interface name of the <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td> +<td>a <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> the interface of the device. This is the internal string used by the +device, and must not be modified. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_device_get_udi ()"> +<a name="nm-device-get-udi"></a><h3>nm_device_get_udi ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_device_get_udi (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>);</pre> +<p> +Gets the Unique Device Identifier of the <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td> +<td>a <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> 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. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_device_get_driver ()"> +<a name="nm-device-get-driver"></a><h3>nm_device_get_driver ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_device_get_driver (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>);</pre> +<p> +Gets the driver of the <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td> +<td>a <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> the driver of the device. This is the internal string used by the +device, and must not be modified. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_device_get_capabilities ()"> +<a name="nm-device-get-capabilities"></a><h3>nm_device_get_capabilities ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_device_get_capabilities (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>);</pre> +<p> +Gets the device' capabilities. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td> +<td>a <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> the capabilities +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_device_get_managed ()"> +<a name="nm-device-get-managed"></a><h3>nm_device_get_managed ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_device_get_managed (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>);</pre> +<p> +Whether the <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> is managed by NetworkManager. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td> +<td>a <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the device is managed by NetworkManager +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_device_get_ip4_config ()"> +<a name="nm-device-get-ip4-config"></a><h3>nm_device_get_ip4_config ()</h3> +<pre class="programlisting"><a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="returnvalue">NMIP4Config</span></a> * nm_device_get_ip4_config (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>);</pre> +<p> +Gets the current <a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> associated with the <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td> +<td>a <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> the <a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the device is not activated. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_device_get_dhcp4_config ()"> +<a name="nm-device-get-dhcp4-config"></a><h3>nm_device_get_dhcp4_config ()</h3> +<pre class="programlisting"><a class="link" href="NMDHCP4Config.html" title="NMDHCP4Config"><span class="returnvalue">NMDHCP4Config</span></a> * nm_device_get_dhcp4_config (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>);</pre> +<p> +Gets the current <a class="link" href="NMDHCP4Config.html" title="NMDHCP4Config"><span class="type">NMDHCP4Config</span></a> associated with the <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td> +<td>a <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> the <span class="type">NMDHCPConfig</span> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the device is not activated or not +using DHCP. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_device_get_ip6_config ()"> +<a name="nm-device-get-ip6-config"></a><h3>nm_device_get_ip6_config ()</h3> +<pre class="programlisting"><a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="returnvalue">NMIP6Config</span></a> * nm_device_get_ip6_config (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>);</pre> +<p> +Gets the current <a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> associated with the <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td> +<td>a <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> the <a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the device is not activated. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_device_get_dhcp6_config ()"> +<a name="nm-device-get-dhcp6-config"></a><h3>nm_device_get_dhcp6_config ()</h3> +<pre class="programlisting"><a class="link" href="NMDHCP6Config.html" title="NMDHCP6Config"><span class="returnvalue">NMDHCP6Config</span></a> * nm_device_get_dhcp6_config (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>);</pre> +<p> +Gets the current <a class="link" href="NMDHCP6Config.html" title="NMDHCP6Config"><span class="type">NMDHCP6Config</span></a> associated with the <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td> +<td>a <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> the <span class="type">NMDHCPConfig</span> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the device is not activated or not +using DHCP. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_device_get_state ()"> +<a name="nm-device-get-state"></a><h3>nm_device_get_state ()</h3> +<pre class="programlisting"><span class="returnvalue">NMDeviceState</span> nm_device_get_state (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>);</pre> +<p> +Gets the current <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> state. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td> +<td>a <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> the current device state +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_device_get_product ()"> +<a name="nm-device-get-product"></a><h3>nm_device_get_product ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_device_get_product (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>);</pre> +<p> +Gets the product string of the <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td> +<td>a <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> the product name of the device. This is the internal string used by the +device, and must not be modified. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_device_get_vendor ()"> +<a name="nm-device-get-vendor"></a><h3>nm_device_get_vendor ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_device_get_vendor (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>);</pre> +<p> +Gets the vendor string of the <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td> +<td>a <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> the vendor name of the device. This is the internal string used by the +device, and must not be modified. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="NMDeviceDeactivateFn ()"> +<a name="NMDeviceDeactivateFn"></a><h3>NMDeviceDeactivateFn ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> (*NMDeviceDeactivateFn) (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="nm_device_disconnect ()"> +<a name="nm-device-disconnect"></a><h3>nm_device_disconnect ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> nm_device_disconnect (<em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device</code></em>, + <em class="parameter"><code><a class="link" href="libnm-glib-nm-device.html#NMDeviceDeactivateFn" title="NMDeviceDeactivateFn ()"><span class="type">NMDeviceDeactivateFn</span></a> callback</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> +<p> +Disconnects the device if currently connected, and prevents the device from +automatically connecting to networks until the next manual network connection +request. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td> +<td>a <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td> +<td>callback to be called when disconnect operation completes +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>caller-specific data passed to <em class="parameter"><code>callback</code></em> +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1" title="Property Details"> +<a name="libnm-glib-nm-device.property-details"></a><h2>Property Details</h2> +<div class="refsect2" title='The "capabilities" property'> +<a name="NMDevice--capabilities"></a><h3>The <code class="literal">"capabilities"</code> property</h3> +<pre class="programlisting"> "capabilities" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read</pre> +<p> +The capabilities of the device. +</p> +<p>Default value: 0</p> +</div> +<hr> +<div class="refsect2" title='The "dhcp4-config" property'> +<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="NMDHCP4Config.html" title="NMDHCP4Config"><span class="type">NMDHCP4Config</span></a>* : Read</pre> +<p> +The <a class="link" href="NMDHCP4Config.html" title="NMDHCP4Config"><span class="type">NMDHCP4Config</span></a> of the device. +</p> +</div> +<hr> +<div class="refsect2" title='The "dhcp6-config" property'> +<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="NMDHCP6Config.html" title="NMDHCP6Config"><span class="type">NMDHCP6Config</span></a>* : Read</pre> +<p> +The <a class="link" href="NMDHCP6Config.html" title="NMDHCP6Config"><span class="type">NMDHCP6Config</span></a> of the device. +</p> +</div> +<hr> +<div class="refsect2" title='The "driver" property'> +<a name="NMDevice--driver"></a><h3>The <code class="literal">"driver"</code> property</h3> +<pre class="programlisting"> "driver" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre> +<p> +The driver of the device. +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2" title='The "interface" property'> +<a name="NMDevice--interface"></a><h3>The <code class="literal">"interface"</code> property</h3> +<pre class="programlisting"> "interface" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre> +<p> +The interface of the device. +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2" title='The "ip4-config" property'> +<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="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a>* : Read</pre> +<p> +The <a class="link" href="NMIP4Config.html" title="NMIP4Config"><span class="type">NMIP4Config</span></a> of the device. +</p> +</div> +<hr> +<div class="refsect2" title='The "ip6-config" property'> +<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="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a>* : Read</pre> +<p> +The <a class="link" href="NMIP6Config.html" title="NMIP6Config"><span class="type">NMIP6Config</span></a> of the device. +</p> +</div> +<hr> +<div class="refsect2" title='The "managed" property'> +<a name="NMDevice--managed"></a><h3>The <code class="literal">"managed"</code> property</h3> +<pre class="programlisting"> "managed" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read</pre> +<p> +Whether the device is managed by NetworkManager. +</p> +<p>Default value: FALSE</p> +</div> +<hr> +<div class="refsect2" title='The "product" property'> +<a name="NMDevice--product"></a><h3>The <code class="literal">"product"</code> property</h3> +<pre class="programlisting"> "product" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre> +<p> +The product string of the device. +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2" title='The "state" property'> +<a name="NMDevice--state"></a><h3>The <code class="literal">"state"</code> property</h3> +<pre class="programlisting"> "state" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read</pre> +<p> +The state of the device. +</p> +<p>Default value: 0</p> +</div> +<hr> +<div class="refsect2" title='The "udi" property'> +<a name="NMDevice--udi"></a><h3>The <code class="literal">"udi"</code> property</h3> +<pre class="programlisting"> "udi" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre> +<p> +The Unique Device Identifier of the device. +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2" title='The "vendor" property'> +<a name="NMDevice--vendor"></a><h3>The <code class="literal">"vendor"</code> property</h3> +<pre class="programlisting"> "vendor" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre> +<p> +The vendor string of the device. +</p> +<p>Default value: NULL</p> +</div> +</div> +<div class="refsect1" title="Signal Details"> +<a name="libnm-glib-nm-device.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2" title='The "state-changed" signal'> +<a name="NMDevice-state-changed"></a><h3>The <code class="literal">"state-changed"</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a> *device, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> state, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> arg2, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> arg3, + <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run First</pre> +<p> +Notifies the state change of a <a class="link" href="libnm-glib-nm-device.html#NMDevice"><span class="type">NMDevice</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td> +<td>the client that received the signal +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td> +<td>the new state of the device +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>user data set when the signal handler was connected.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.14</div> +</body> +</html> \ No newline at end of file |