diff options
| author | Michael Biebl <biebl@debian.org> | 2015-05-05 17:48:57 +0200 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2015-05-05 17:48:57 +0200 |
| commit | f408e27bccfacf347605a8d98649975a68f38a17 (patch) | |
| tree | 654fd6695c31511baf919b1c0870d119a352ed75 /docs/libnm-glib/html/NMDeviceBridge.html | |
| parent | 2c032d8f1c6292c1338a615e6ec40252889ba85c (diff) | |
Imported Upstream version 1.0.2 upstream/1.0.2
Diffstat (limited to 'docs/libnm-glib/html/NMDeviceBridge.html')
| -rw-r--r-- | docs/libnm-glib/html/NMDeviceBridge.html | 534 |
1 files changed, 293 insertions, 241 deletions
diff --git a/docs/libnm-glib/html/NMDeviceBridge.html b/docs/libnm-glib/html/NMDeviceBridge.html index e2bb740c..192be733 100644 --- a/docs/libnm-glib/html/NMDeviceBridge.html +++ b/docs/libnm-glib/html/NMDeviceBridge.html @@ -2,36 +2,28 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>NMDeviceBridge</title> +<title>libnm-glib Reference Manual: NMDeviceBridge</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="libnm-glib Reference Manual"> <link rel="up" href="ch02.html" title="libnm-glib API Reference"> <link rel="prev" href="NMDeviceBond.html" title="NMDeviceBond"> <link rel="next" href="NMDeviceTeam.html" title="NMDeviceTeam"> -<meta name="generator" content="GTK-Doc V1.19 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.21 (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="NMDeviceBond.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="ch02.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="NMDeviceTeam.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#NMDeviceBridge.synopsis" class="shortcut">Top</a> - | - <a href="#NMDeviceBridge.description" class="shortcut">Description</a> - | - <a href="#NMDeviceBridge.object-hierarchy" class="shortcut">Object Hierarchy</a> - | - <a href="#NMDeviceBridge.implemented-interfaces" class="shortcut">Implemented Interfaces</a> - | - <a href="#NMDeviceBridge.properties" class="shortcut">Properties</a> -</td></tr> -</table> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#NMDeviceBridge.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#NMDeviceBridge.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#NMDeviceBridge.properties" class="shortcut">Properties</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="NMDeviceBond.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="NMDeviceTeam.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> <div class="refentry"> <a name="NMDeviceBridge"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -39,46 +31,123 @@ <h2><span class="refentrytitle"><a name="NMDeviceBridge.top_of_page"></a>NMDeviceBridge</span></h2> <p>NMDeviceBridge</p> </td> -<td valign="top" align="right"></td> +<td class="gallery_image" valign="top" align="right"></td> </tr></table></div> -<div class="refsynopsisdiv"> -<a name="NMDeviceBridge.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis">enum <a class="link" href="NMDeviceBridge.html#NMDeviceBridgeError" title="enum NMDeviceBridgeError">NMDeviceBridgeError</a>; -#define <a class="link" href="NMDeviceBridge.html#NM-DEVICE-BRIDGE-ERROR:CAPS" title="NM_DEVICE_BRIDGE_ERROR">NM_DEVICE_BRIDGE_ERROR</a> -<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> <a class="link" href="NMDeviceBridge.html#nm-device-bridge-error-quark" title="nm_device_bridge_error_quark ()">nm_device_bridge_error_quark</a> (<em class="parameter"><code><span class="type">void</span></code></em>); -#define <a class="link" href="NMDeviceBridge.html#NM-DEVICE-BRIDGE-HW-ADDRESS:CAPS" title="NM_DEVICE_BRIDGE_HW_ADDRESS">NM_DEVICE_BRIDGE_HW_ADDRESS</a> -#define <a class="link" href="NMDeviceBridge.html#NM-DEVICE-BRIDGE-CARRIER:CAPS" title="NM_DEVICE_BRIDGE_CARRIER">NM_DEVICE_BRIDGE_CARRIER</a> -#define <a class="link" href="NMDeviceBridge.html#NM-DEVICE-BRIDGE-SLAVES:CAPS" title="NM_DEVICE_BRIDGE_SLAVES">NM_DEVICE_BRIDGE_SLAVES</a> - <a class="link" href="NMDeviceBridge.html#NMDeviceBridge-struct" title="NMDeviceBridge">NMDeviceBridge</a>; - <a class="link" href="NMDeviceBridge.html#NMDeviceBridgeClass" title="NMDeviceBridgeClass">NMDeviceBridgeClass</a>; -<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * <a class="link" href="NMDeviceBridge.html#nm-device-bridge-new" title="nm_device_bridge_new ()">nm_device_bridge_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="NMDeviceBridge.html#nm-device-bridge-get-hw-address" title="nm_device_bridge_get_hw_address ()">nm_device_bridge_get_hw_address</a> (<em class="parameter"><code><a class="link" href="NMDeviceBridge.html" title="NMDeviceBridge"><span class="type">NMDeviceBridge</span></a> *device</code></em>); -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="NMDeviceBridge.html#nm-device-bridge-get-carrier" title="nm_device_bridge_get_carrier ()">nm_device_bridge_get_carrier</a> (<em class="parameter"><code><a class="link" href="NMDeviceBridge.html" title="NMDeviceBridge"><span class="type">NMDeviceBridge</span></a> *device</code></em>); -const <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * <a class="link" href="NMDeviceBridge.html#nm-device-bridge-get-slaves" title="nm_device_bridge_get_slaves ()">nm_device_bridge_get_slaves</a> (<em class="parameter"><code><a class="link" href="NMDeviceBridge.html" title="NMDeviceBridge"><span class="type">NMDeviceBridge</span></a> *device</code></em>); -</pre> +<div class="refsect1"> +<a name="NMDeviceBridge.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<span class="returnvalue">GQuark</span> +</td> +<td class="function_name"> +<a class="link" href="NMDeviceBridge.html#nm-device-bridge-error-quark" title="nm_device_bridge_error_quark ()">nm_device_bridge_error_quark</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GObject</span> * +</td> +<td class="function_name"> +<a class="link" href="NMDeviceBridge.html#nm-device-bridge-new" title="nm_device_bridge_new ()">nm_device_bridge_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="NMDeviceBridge.html#nm-device-bridge-get-hw-address" title="nm_device_bridge_get_hw_address ()">nm_device_bridge_get_hw_address</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="NMDeviceBridge.html#nm-device-bridge-get-carrier" title="nm_device_bridge_get_carrier ()">nm_device_bridge_get_carrier</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <span class="returnvalue">GPtrArray</span> * +</td> +<td class="function_name"> +<a class="link" href="NMDeviceBridge.html#nm-device-bridge-get-slaves" title="nm_device_bridge_get_slaves ()">nm_device_bridge_get_slaves</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> </div> <div class="refsect1"> -<a name="NMDeviceBridge.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="synopsis"> - <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> - +----<a class="link" href="NMObject.html" title="NMObject">NMObject</a> - +----<a class="link" href="NMDevice.html" title="NMDevice">NMDevice</a> - +----NMDeviceBridge -</pre> +<a name="NMDeviceBridge.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"><span class="type">gboolean</span></td> +<td class="property_name"><a class="link" href="NMDeviceBridge.html#NMDeviceBridge--carrier" title="The “carrier” property">carrier</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"> +<span class="type">gchar</span> *</td> +<td class="property_name"><a class="link" href="NMDeviceBridge.html#NMDeviceBridge--hw-address" title="The “hw-address” property">hw-address</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"> +<span class="type">NMObjectArray</span> *</td> +<td class="property_name"><a class="link" href="NMDeviceBridge.html#NMDeviceBridge--slaves" title="The “slaves” property">slaves</a></td> +<td class="property_flags">Read</td> +</tr> +</tbody> +</table></div> </div> <div class="refsect1"> -<a name="NMDeviceBridge.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -NMDeviceBridge implements - <a href="http://library.gnome.org/devel/gio/unstable/GInitable.html">GInitable</a> and <a href="http://library.gnome.org/devel/gio/unstable/GAsyncInitable.html">GAsyncInitable</a>.</p> +<a name="NMDeviceBridge.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="NMDeviceBridge.html#NMDeviceBridgeError" title="enum NMDeviceBridgeError">NMDeviceBridgeError</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMDeviceBridge.html#NM-DEVICE-BRIDGE-ERROR:CAPS" title="NM_DEVICE_BRIDGE_ERROR">NM_DEVICE_BRIDGE_ERROR</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMDeviceBridge.html#NM-DEVICE-BRIDGE-HW-ADDRESS:CAPS" title="NM_DEVICE_BRIDGE_HW_ADDRESS">NM_DEVICE_BRIDGE_HW_ADDRESS</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMDeviceBridge.html#NM-DEVICE-BRIDGE-CARRIER:CAPS" title="NM_DEVICE_BRIDGE_CARRIER">NM_DEVICE_BRIDGE_CARRIER</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMDeviceBridge.html#NM-DEVICE-BRIDGE-SLAVES:CAPS" title="NM_DEVICE_BRIDGE_SLAVES">NM_DEVICE_BRIDGE_SLAVES</a></td> +</tr> +</tbody> +</table></div> </div> <div class="refsect1"> -<a name="NMDeviceBridge.properties"></a><h2>Properties</h2> -<pre class="synopsis"> - "<a class="link" href="NMDeviceBridge.html#NMDeviceBridge--carrier" title='The "carrier" property'>carrier</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read - "<a class="link" href="NMDeviceBridge.html#NMDeviceBridge--hw-address" title='The "hw-address" property'>hw-address</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read - "<a class="link" href="NMDeviceBridge.html#NMDeviceBridge--slaves" title='The "slaves" property'>slaves</a>" <span class="type">NMObjectArray</span>* : Read +<a name="NMDeviceBridge.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> GObject + <span class="lineart">╰──</span> <a class="link" href="NMObject.html" title="NMObject">NMObject</a> + <span class="lineart">╰──</span> <a class="link" href="NMDevice.html" title="NMDevice">NMDevice</a> + <span class="lineart">╰──</span> NMDeviceBridge </pre> </div> <div class="refsect1"> @@ -87,272 +156,255 @@ NMDeviceBridge implements </p> </div> <div class="refsect1"> -<a name="NMDeviceBridge.details"></a><h2>Details</h2> +<a name="NMDeviceBridge.functions_details"></a><h2>Functions</h2> <div class="refsect2"> -<a name="NMDeviceBridgeError"></a><h3>enum NMDeviceBridgeError</h3> -<pre class="programlisting">typedef enum { - NM_DEVICE_BRIDGE_ERROR_UNKNOWN = 0, /*< nick=UnknownError >*/ - NM_DEVICE_BRIDGE_ERROR_NOT_BRIDGE_CONNECTION, /*< nick=NotBridgeConnection >*/ - NM_DEVICE_BRIDGE_ERROR_INVALID_BRIDGE_CONNECTION, /*< nick=InvalidBridgeConnection >*/ - NM_DEVICE_BRIDGE_ERROR_INTERFACE_MISMATCH, /*< nick=InterfaceMismatch >*/ -} NMDeviceBridgeError; -</pre> -<div class="variablelist"><table border="0" class="variablelist"> +<a name="nm-device-bridge-error-quark"></a><h3>nm_device_bridge_error_quark ()</h3> +<pre class="programlisting"><span class="returnvalue">GQuark</span> +nm_device_bridge_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p>Registers an error quark for <a class="link" href="NMDeviceBridge.html" title="NMDeviceBridge"><span class="type">NMDeviceBridge</span></a> if necessary.</p> +<div class="refsect3"> +<a name="id-1.3.12.8.2.5"></a><h4>Returns</h4> +<p> the error quark used for <a class="link" href="NMDeviceBridge.html" title="NMDeviceBridge"><span class="type">NMDeviceBridge</span></a> errors.</p> +<p></p> +</div> +<p class="since">Since 0.9.8</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-device-bridge-new"></a><h3>nm_device_bridge_new ()</h3> +<pre class="programlisting"><span class="returnvalue">GObject</span> * +nm_device_bridge_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="NMDeviceBridge.html" title="NMDeviceBridge"><span class="type">NMDeviceBridge</span></a>.</p> +<div class="refsect3"> +<a name="id-1.3.12.8.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> -<td><p><a name="NM-DEVICE-BRIDGE-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_DEVICE_BRIDGE_ERROR_UNKNOWN</code></span></p></td> -<td>unknown or unclassified error -</td> -</tr> -<tr> -<td><p><a name="NM-DEVICE-BRIDGE-ERROR-NOT-BRIDGE-CONNECTION:CAPS"></a><span class="term"><code class="literal">NM_DEVICE_BRIDGE_ERROR_NOT_BRIDGE_CONNECTION</code></span></p></td> -<td>the connection was not of bridge type -</td> +<td class="parameter_name"><p>connection</p></td> +<td class="parameter_description"><p>the <a href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGConnection.html#DBusGConnection"><span class="type">DBusGConnection</span></a></p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><a name="NM-DEVICE-BRIDGE-ERROR-INVALID-BRIDGE-CONNECTION:CAPS"></a><span class="term"><code class="literal">NM_DEVICE_BRIDGE_ERROR_INVALID_BRIDGE_CONNECTION</code></span></p></td> -<td>the bridge connection was invalid -</td> -</tr> -<tr> -<td><p><a name="NM-DEVICE-BRIDGE-ERROR-INTERFACE-MISMATCH:CAPS"></a><span class="term"><code class="literal">NM_DEVICE_BRIDGE_ERROR_INTERFACE_MISMATCH</code></span></p></td> -<td>the interfaces of the connection and the device mismatched -</td> +<td class="parameter_name"><p>path</p></td> +<td class="parameter_description"><p>the DBus object path of the device</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> -<p class="since">Since 0.9.8</p> </div> -<hr> -<div class="refsect2"> -<a name="NM-DEVICE-BRIDGE-ERROR:CAPS"></a><h3>NM_DEVICE_BRIDGE_ERROR</h3> -<pre class="programlisting">#define NM_DEVICE_BRIDGE_ERROR nm_device_bridge_error_quark () -</pre> -<p> -</p> +<div class="refsect3"> +<a name="id-1.3.12.8.3.6"></a><h4>Returns</h4> +<p> a new device. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +<p class="since">Since 0.9.8</p> </div> <hr> <div class="refsect2"> -<a name="nm-device-bridge-error-quark"></a><h3>nm_device_bridge_error_quark ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> nm_device_bridge_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p> -Registers an error quark for <a class="link" href="NMDeviceBridge.html" title="NMDeviceBridge"><span class="type">NMDeviceBridge</span></a> if necessary. -</p> -<div class="variablelist"><table border="0" class="variablelist"> +<a name="nm-device-bridge-get-hw-address"></a><h3>nm_device_bridge_get_hw_address ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +nm_device_bridge_get_hw_address (<em class="parameter"><code><a class="link" href="NMDeviceBridge.html" title="NMDeviceBridge"><span class="type">NMDeviceBridge</span></a> *device</code></em>);</pre> +<p>Gets the hardware (MAC) address of the <a class="link" href="NMDeviceBridge.html" title="NMDeviceBridge"><span class="type">NMDeviceBridge</span></a></p> +<div class="refsect3"> +<a name="id-1.3.12.8.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> </colgroup> <tbody><tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the error quark used for <a class="link" href="NMDeviceBridge.html" title="NMDeviceBridge"><span class="type">NMDeviceBridge</span></a> errors.</td> +<td class="parameter_name"><p>device</p></td> +<td class="parameter_description"><p>a <a class="link" href="NMDeviceBridge.html" title="NMDeviceBridge"><span class="type">NMDeviceBridge</span></a></p></td> +<td class="parameter_annotations"> </td> </tr></tbody> </table></div> +</div> +<div class="refsect3"> +<a name="id-1.3.12.8.4.6"></a><h4>Returns</h4> +<p> the hardware address. This is the internal string used by the +device, and must not be modified.</p> +<p></p> +</div> <p class="since">Since 0.9.8</p> </div> <hr> <div class="refsect2"> -<a name="NM-DEVICE-BRIDGE-HW-ADDRESS:CAPS"></a><h3>NM_DEVICE_BRIDGE_HW_ADDRESS</h3> -<pre class="programlisting">#define NM_DEVICE_BRIDGE_HW_ADDRESS "hw-address" -</pre> -<p> -</p> +<a name="nm-device-bridge-get-carrier"></a><h3>nm_device_bridge_get_carrier ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +nm_device_bridge_get_carrier (<em class="parameter"><code><a class="link" href="NMDeviceBridge.html" title="NMDeviceBridge"><span class="type">NMDeviceBridge</span></a> *device</code></em>);</pre> +<p>Whether the device has carrier.</p> +<div class="refsect3"> +<a name="id-1.3.12.8.5.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>a <a class="link" href="NMDeviceBridge.html" title="NMDeviceBridge"><span class="type">NMDeviceBridge</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> </div> -<hr> -<div class="refsect2"> -<a name="NM-DEVICE-BRIDGE-CARRIER:CAPS"></a><h3>NM_DEVICE_BRIDGE_CARRIER</h3> -<pre class="programlisting">#define NM_DEVICE_BRIDGE_CARRIER "carrier" -</pre> -<p> -</p> +<div class="refsect3"> +<a name="id-1.3.12.8.5.6"></a><h4>Returns</h4> +<p> <code class="literal">TRUE</code> if the device has carrier</p> +<p></p> </div> -<hr> -<div class="refsect2"> -<a name="NM-DEVICE-BRIDGE-SLAVES:CAPS"></a><h3>NM_DEVICE_BRIDGE_SLAVES</h3> -<pre class="programlisting">#define NM_DEVICE_BRIDGE_SLAVES "slaves" -</pre> -<p> -</p> +<p class="since">Since 0.9.8</p> </div> <hr> <div class="refsect2"> -<a name="NMDeviceBridge-struct"></a><h3>NMDeviceBridge</h3> -<pre class="programlisting">typedef struct _NMDeviceBridge NMDeviceBridge;</pre> -<p> -</p> +<a name="nm-device-bridge-get-slaves"></a><h3>nm_device_bridge_get_slaves ()</h3> +<pre class="programlisting">const <span class="returnvalue">GPtrArray</span> * +nm_device_bridge_get_slaves (<em class="parameter"><code><a class="link" href="NMDeviceBridge.html" title="NMDeviceBridge"><span class="type">NMDeviceBridge</span></a> *device</code></em>);</pre> +<p>Gets the devices currently slaved to <em class="parameter"><code>device</code></em> +.</p> +<div class="refsect3"> +<a name="id-1.3.12.8.6.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>a <a class="link" href="NMDeviceBridge.html" title="NMDeviceBridge"><span class="type">NMDeviceBridge</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> </div> -<hr> -<div class="refsect2"> -<a name="NMDeviceBridgeClass"></a><h3>NMDeviceBridgeClass</h3> -<pre class="programlisting">typedef struct { - NMDeviceClass parent; - - /* Padding for future expansion */ - void (*_reserved1) (void); - void (*_reserved2) (void); - void (*_reserved3) (void); - void (*_reserved4) (void); - void (*_reserved5) (void); - void (*_reserved6) (void); -} NMDeviceBridgeClass; -</pre> -<p> -</p> +<div class="refsect3"> +<a name="id-1.3.12.8.6.6"></a><h4>Returns</h4> +<p> the <span class="type">GPtrArray</span> containing +<a href="NMDevice.html"><span class="type">NMDevices</span></a> that are slaves of <em class="parameter"><code>device</code></em> +. This is the internal +copy used by the device, and must not be modified. </p> +<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NMDevice]</span></p> </div> -<hr> +<p class="since">Since 0.9.8</p> +</div> +</div> +<div class="refsect1"> +<a name="NMDeviceBridge.other_details"></a><h2>Types and Values</h2> <div class="refsect2"> -<a name="nm-device-bridge-new"></a><h3>nm_device_bridge_new ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> * nm_device_bridge_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="NMDeviceBridge.html" title="NMDeviceBridge"><span class="type">NMDeviceBridge</span></a>. -</p> -<div class="variablelist"><table border="0" class="variablelist"> +<a name="NMDeviceBridgeError"></a><h3>enum NMDeviceBridgeError</h3> +<div class="refsect3"> +<a name="id-1.3.12.9.2.3"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="300px" class="enum_members_name"> +<col class="enum_members_description"> +<col width="200px" class="enum_members_annotations"> </colgroup> <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 class="enum_member_name"><p><a name="NM-DEVICE-BRIDGE-ERROR-UNKNOWN:CAPS"></a>NM_DEVICE_BRIDGE_ERROR_UNKNOWN</p></td> +<td class="enum_member_description"> +<p>unknown or unclassified error</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="NM-DEVICE-BRIDGE-ERROR-NOT-BRIDGE-CONNECTION:CAPS"></a>NM_DEVICE_BRIDGE_ERROR_NOT_BRIDGE_CONNECTION</p></td> +<td class="enum_member_description"> +<p>the connection was not of bridge type</p> </td> +<td class="enum_member_annotations"> </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> +<td class="enum_member_name"><p><a name="NM-DEVICE-BRIDGE-ERROR-INVALID-BRIDGE-CONNECTION:CAPS"></a>NM_DEVICE_BRIDGE_ERROR_INVALID_BRIDGE_CONNECTION</p></td> +<td class="enum_member_description"> +<p>the bridge connection was invalid</p> +</td> +<td class="enum_member_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a new device. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +<td class="enum_member_name"><p><a name="NM-DEVICE-BRIDGE-ERROR-INTERFACE-MISMATCH:CAPS"></a>NM_DEVICE_BRIDGE_ERROR_INTERFACE_MISMATCH</p></td> +<td class="enum_member_description"> +<p>the interfaces of the connection and the device mismatched</p> </td> +<td class="enum_member_annotations"> </td> </tr> </tbody> </table></div> +</div> <p class="since">Since 0.9.8</p> </div> <hr> <div class="refsect2"> -<a name="nm-device-bridge-get-hw-address"></a><h3>nm_device_bridge_get_hw_address ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * nm_device_bridge_get_hw_address (<em class="parameter"><code><a class="link" href="NMDeviceBridge.html" title="NMDeviceBridge"><span class="type">NMDeviceBridge</span></a> *device</code></em>);</pre> +<a name="NM-DEVICE-BRIDGE-ERROR:CAPS"></a><h3>NM_DEVICE_BRIDGE_ERROR</h3> +<pre class="programlisting">#define NM_DEVICE_BRIDGE_ERROR nm_device_bridge_error_quark () +</pre> <p> -Gets the hardware (MAC) address of the <a class="link" href="NMDeviceBridge.html" title="NMDeviceBridge"><span class="type">NMDeviceBridge</span></a> </p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td> -<td>a <a class="link" href="NMDeviceBridge.html" title="NMDeviceBridge"><span class="type">NMDeviceBridge</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the hardware address. This is the internal string used by the -device, and must not be modified.</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 0.9.8</p> </div> <hr> <div class="refsect2"> -<a name="nm-device-bridge-get-carrier"></a><h3>nm_device_bridge_get_carrier ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_device_bridge_get_carrier (<em class="parameter"><code><a class="link" href="NMDeviceBridge.html" title="NMDeviceBridge"><span class="type">NMDeviceBridge</span></a> *device</code></em>);</pre> +<a name="NM-DEVICE-BRIDGE-HW-ADDRESS:CAPS"></a><h3>NM_DEVICE_BRIDGE_HW_ADDRESS</h3> +<pre class="programlisting">#define NM_DEVICE_BRIDGE_HW_ADDRESS "hw-address" +</pre> <p> -Whether the device has carrier. </p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td> -<td>a <a class="link" href="NMDeviceBridge.html" title="NMDeviceBridge"><span class="type">NMDeviceBridge</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> -<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the device has carrier</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 0.9.8</p> </div> <hr> <div class="refsect2"> -<a name="nm-device-bridge-get-slaves"></a><h3>nm_device_bridge_get_slaves ()</h3> -<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * nm_device_bridge_get_slaves (<em class="parameter"><code><a class="link" href="NMDeviceBridge.html" title="NMDeviceBridge"><span class="type">NMDeviceBridge</span></a> *device</code></em>);</pre> +<a name="NM-DEVICE-BRIDGE-CARRIER:CAPS"></a><h3>NM_DEVICE_BRIDGE_CARRIER</h3> +<pre class="programlisting">#define NM_DEVICE_BRIDGE_CARRIER "carrier" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-DEVICE-BRIDGE-SLAVES:CAPS"></a><h3>NM_DEVICE_BRIDGE_SLAVES</h3> +<pre class="programlisting">#define NM_DEVICE_BRIDGE_SLAVES "slaves" +</pre> <p> -Gets the devices currently slaved to <em class="parameter"><code>device</code></em>. </p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td> -<td>a <a class="link" href="NMDeviceBridge.html" title="NMDeviceBridge"><span class="type">NMDeviceBridge</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing -<a href="NMDevice.html"><span class="type">NMDevices</span></a> that are slaves of <em class="parameter"><code>device</code></em>. This is the internal -copy used by the device, and must not be modified. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NMDevice]</span> -</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 0.9.8</p> </div> </div> <div class="refsect1"> <a name="NMDeviceBridge.property-details"></a><h2>Property Details</h2> <div class="refsect2"> -<a name="NMDeviceBridge--carrier"></a><h3>The <code class="literal">"carrier"</code> property</h3> -<pre class="programlisting"> "carrier" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read</pre> -<p> -Whether the device has carrier. -</p> +<a name="NMDeviceBridge--carrier"></a><h3>The <code class="literal">“carrier”</code> property</h3> +<pre class="programlisting"> “carrier” <span class="type">gboolean</span></pre> +<p></p> +<p>Flags: Read</p> <p>Default value: FALSE</p> <p class="since">Since 0.9.8</p> </div> <hr> <div class="refsect2"> -<a name="NMDeviceBridge--hw-address"></a><h3>The <code class="literal">"hw-address"</code> property</h3> -<pre class="programlisting"> "hw-address" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre> -<p> -The hardware (MAC) address of the device. -</p> +<a name="NMDeviceBridge--hw-address"></a><h3>The <code class="literal">“hw-address”</code> property</h3> +<pre class="programlisting"> “hw-address” <span class="type">gchar</span> *</pre> +<p></p> +<p>Flags: Read</p> <p>Default value: NULL</p> <p class="since">Since 0.9.8</p> </div> <hr> <div class="refsect2"> -<a name="NMDeviceBridge--slaves"></a><h3>The <code class="literal">"slaves"</code> property</h3> -<pre class="programlisting"> "slaves" <span class="type">NMObjectArray</span>* : Read</pre> -<p> -The devices (<a class="link" href="NMDevice.html" title="NMDevice"><span class="type">NMDevice</span></a>) slaved to the bridge device. -</p> +<a name="NMDeviceBridge--slaves"></a><h3>The <code class="literal">“slaves”</code> property</h3> +<pre class="programlisting"> “slaves” <span class="type">NMObjectArray</span> *</pre> +<p></p> +<p>Flags: Read</p> <p class="since">Since 0.9.8</p> </div> </div> </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.19</div> + Generated by GTK-Doc V1.21</div> </body> </html> \ No newline at end of file |