diff options
Diffstat (limited to 'docs/libnm-glib/html/NMDeviceTeam.html')
| -rw-r--r-- | docs/libnm-glib/html/NMDeviceTeam.html | 354 |
1 files changed, 354 insertions, 0 deletions
diff --git a/docs/libnm-glib/html/NMDeviceTeam.html b/docs/libnm-glib/html/NMDeviceTeam.html new file mode 100644 index 000000000..4557c4b95 --- /dev/null +++ b/docs/libnm-glib/html/NMDeviceTeam.html @@ -0,0 +1,354 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>NMDeviceTeam</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="NMDeviceBridge.html" title="NMDeviceBridge"> +<link rel="next" href="NMDeviceGeneric.html" title="NMDeviceGeneric"> +<meta name="generator" content="GTK-Doc V1.19 (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="NMDeviceBridge.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="NMDeviceGeneric.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#NMDeviceTeam.synopsis" class="shortcut">Top</a> + | + <a href="#NMDeviceTeam.description" class="shortcut">Description</a> + | + <a href="#NMDeviceTeam.object-hierarchy" class="shortcut">Object Hierarchy</a> + | + <a href="#NMDeviceTeam.implemented-interfaces" class="shortcut">Implemented Interfaces</a> + | + <a href="#NMDeviceTeam.properties" class="shortcut">Properties</a> +</td></tr> +</table> +<div class="refentry"> +<a name="NMDeviceTeam"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="NMDeviceTeam.top_of_page"></a>NMDeviceTeam</span></h2> +<p>NMDeviceTeam</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="NMDeviceTeam.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">enum <a class="link" href="NMDeviceTeam.html#NMDeviceTeamError" title="enum NMDeviceTeamError">NMDeviceTeamError</a>; +#define <a class="link" href="NMDeviceTeam.html#NM-DEVICE-TEAM-ERROR:CAPS" title="NM_DEVICE_TEAM_ERROR">NM_DEVICE_TEAM_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="NMDeviceTeam.html#nm-device-team-error-quark" title="nm_device_team_error_quark ()">nm_device_team_error_quark</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +#define <a class="link" href="NMDeviceTeam.html#NM-DEVICE-TEAM-HW-ADDRESS:CAPS" title="NM_DEVICE_TEAM_HW_ADDRESS">NM_DEVICE_TEAM_HW_ADDRESS</a> +#define <a class="link" href="NMDeviceTeam.html#NM-DEVICE-TEAM-CARRIER:CAPS" title="NM_DEVICE_TEAM_CARRIER">NM_DEVICE_TEAM_CARRIER</a> +#define <a class="link" href="NMDeviceTeam.html#NM-DEVICE-TEAM-SLAVES:CAPS" title="NM_DEVICE_TEAM_SLAVES">NM_DEVICE_TEAM_SLAVES</a> + <a class="link" href="NMDeviceTeam.html#NMDeviceTeam-struct" title="NMDeviceTeam">NMDeviceTeam</a>; + <a class="link" href="NMDeviceTeam.html#NMDeviceTeamClass" title="NMDeviceTeamClass">NMDeviceTeamClass</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="NMDeviceTeam.html#nm-device-team-new" title="nm_device_team_new ()">nm_device_team_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="NMDeviceTeam.html#nm-device-team-get-hw-address" title="nm_device_team_get_hw_address ()">nm_device_team_get_hw_address</a> (<em class="parameter"><code><a class="link" href="NMDeviceTeam.html" title="NMDeviceTeam"><span class="type">NMDeviceTeam</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="NMDeviceTeam.html#nm-device-team-get-carrier" title="nm_device_team_get_carrier ()">nm_device_team_get_carrier</a> (<em class="parameter"><code><a class="link" href="NMDeviceTeam.html" title="NMDeviceTeam"><span class="type">NMDeviceTeam</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="NMDeviceTeam.html#nm-device-team-get-slaves" title="nm_device_team_get_slaves ()">nm_device_team_get_slaves</a> (<em class="parameter"><code><a class="link" href="NMDeviceTeam.html" title="NMDeviceTeam"><span class="type">NMDeviceTeam</span></a> *device</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="NMDeviceTeam.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> + +----NMDeviceTeam +</pre> +</div> +<div class="refsect1"> +<a name="NMDeviceTeam.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +NMDeviceTeam 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> +</div> +<div class="refsect1"> +<a name="NMDeviceTeam.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="NMDeviceTeam.html#NMDeviceTeam--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="NMDeviceTeam.html#NMDeviceTeam--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="NMDeviceTeam.html#NMDeviceTeam--slaves" title='The "slaves" property'>slaves</a>" <span class="type">NMObjectArray</span>* : Read +</pre> +</div> +<div class="refsect1"> +<a name="NMDeviceTeam.description"></a><h2>Description</h2> +<p> +</p> +</div> +<div class="refsect1"> +<a name="NMDeviceTeam.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="NMDeviceTeamError"></a><h3>enum NMDeviceTeamError</h3> +<pre class="programlisting">typedef enum { + NM_DEVICE_TEAM_ERROR_UNKNOWN = 0, /*< nick=UnknownError >*/ + NM_DEVICE_TEAM_ERROR_NOT_TEAM_CONNECTION, /*< nick=NotTeamConnection >*/ + NM_DEVICE_TEAM_ERROR_INVALID_TEAM_CONNECTION, /*< nick=InvalidTeamConnection >*/ + NM_DEVICE_TEAM_ERROR_INTERFACE_MISMATCH, /*< nick=InterfaceMismatch >*/ +} NMDeviceTeamError; +</pre> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><a name="NM-DEVICE-TEAM-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_DEVICE_TEAM_ERROR_UNKNOWN</code></span></p></td> +<td>unknown or unclassified error +</td> +</tr> +<tr> +<td><p><a name="NM-DEVICE-TEAM-ERROR-NOT-TEAM-CONNECTION:CAPS"></a><span class="term"><code class="literal">NM_DEVICE_TEAM_ERROR_NOT_TEAM_CONNECTION</code></span></p></td> +<td>the connection was not of team type +</td> +</tr> +<tr> +<td><p><a name="NM-DEVICE-TEAM-ERROR-INVALID-TEAM-CONNECTION:CAPS"></a><span class="term"><code class="literal">NM_DEVICE_TEAM_ERROR_INVALID_TEAM_CONNECTION</code></span></p></td> +<td>the team connection was invalid +</td> +</tr> +<tr> +<td><p><a name="NM-DEVICE-TEAM-ERROR-INTERFACE-MISMATCH:CAPS"></a><span class="term"><code class="literal">NM_DEVICE_TEAM_ERROR_INTERFACE_MISMATCH</code></span></p></td> +<td>the interfaces of the connection and the device mismatched +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="NM-DEVICE-TEAM-ERROR:CAPS"></a><h3>NM_DEVICE_TEAM_ERROR</h3> +<pre class="programlisting">#define NM_DEVICE_TEAM_ERROR nm_device_team_error_quark () +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-device-team-error-quark"></a><h3>nm_device_team_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_team_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Registers an error quark for <a class="link" href="NMDeviceTeam.html" title="NMDeviceTeam"><span class="type">NMDeviceTeam</span></a> if necessary. +</p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</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="NMDeviceTeam.html" title="NMDeviceTeam"><span class="type">NMDeviceTeam</span></a> errors.</td> +</tr></tbody> +</table></div> +<p class="since">Since 0.9.10</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-DEVICE-TEAM-HW-ADDRESS:CAPS"></a><h3>NM_DEVICE_TEAM_HW_ADDRESS</h3> +<pre class="programlisting">#define NM_DEVICE_TEAM_HW_ADDRESS "hw-address" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-DEVICE-TEAM-CARRIER:CAPS"></a><h3>NM_DEVICE_TEAM_CARRIER</h3> +<pre class="programlisting">#define NM_DEVICE_TEAM_CARRIER "carrier" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-DEVICE-TEAM-SLAVES:CAPS"></a><h3>NM_DEVICE_TEAM_SLAVES</h3> +<pre class="programlisting">#define NM_DEVICE_TEAM_SLAVES "slaves" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceTeam-struct"></a><h3>NMDeviceTeam</h3> +<pre class="programlisting">typedef struct _NMDeviceTeam NMDeviceTeam;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceTeamClass"></a><h3>NMDeviceTeamClass</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); +} NMDeviceTeamClass; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-device-team-new"></a><h3>nm_device_team_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_team_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="NMDeviceTeam.html" title="NMDeviceTeam"><span class="type">NMDeviceTeam</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>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. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +<p class="since">Since 0.9.10</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-device-team-get-hw-address"></a><h3>nm_device_team_get_hw_address ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * nm_device_team_get_hw_address (<em class="parameter"><code><a class="link" href="NMDeviceTeam.html" title="NMDeviceTeam"><span class="type">NMDeviceTeam</span></a> *device</code></em>);</pre> +<p> +Gets the hardware (MAC) address of the <a class="link" href="NMDeviceTeam.html" title="NMDeviceTeam"><span class="type">NMDeviceTeam</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="NMDeviceTeam.html" title="NMDeviceTeam"><span class="type">NMDeviceTeam</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.10</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-device-team-get-carrier"></a><h3>nm_device_team_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_team_get_carrier (<em class="parameter"><code><a class="link" href="NMDeviceTeam.html" title="NMDeviceTeam"><span class="type">NMDeviceTeam</span></a> *device</code></em>);</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="NMDeviceTeam.html" title="NMDeviceTeam"><span class="type">NMDeviceTeam</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.10</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-device-team-get-slaves"></a><h3>nm_device_team_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_team_get_slaves (<em class="parameter"><code><a class="link" href="NMDeviceTeam.html" title="NMDeviceTeam"><span class="type">NMDeviceTeam</span></a> *device</code></em>);</pre> +<p> +Gets the devices currently enslaved 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="NMDeviceTeam.html" title="NMDeviceTeam"><span class="type">NMDeviceTeam</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> NMClient.Device]</span> +</td> +</tr> +</tbody> +</table></div> +<p class="since">Since 0.9.10</p> +</div> +</div> +<div class="refsect1"> +<a name="NMDeviceTeam.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="NMDeviceTeam--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> +<p>Default value: FALSE</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceTeam--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> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceTeam--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>) enslaved to the team device. +</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19</div> +</body> +</html>
\ No newline at end of file |