diff options
Diffstat (limited to 'docs/libnm/html/NMDeviceInfiniband.html')
| -rw-r--r-- | docs/libnm/html/NMDeviceInfiniband.html | 276 |
1 files changed, 149 insertions, 127 deletions
diff --git a/docs/libnm/html/NMDeviceInfiniband.html b/docs/libnm/html/NMDeviceInfiniband.html index b5646e85..60783944 100644 --- a/docs/libnm/html/NMDeviceInfiniband.html +++ b/docs/libnm/html/NMDeviceInfiniband.html @@ -2,36 +2,28 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>NMDeviceInfiniband</title> +<title>libnm Reference Manual: NMDeviceInfiniband</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="libnm Reference Manual"> <link rel="up" href="ch04.html" title="Device and Runtime Configuration API Reference"> <link rel="prev" href="NMDeviceGeneric.html" title="NMDeviceGeneric"> <link rel="next" href="NMDeviceModem.html" title="NMDeviceModem"> -<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="NMDeviceGeneric.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="ch04.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 Reference Manual</th> -<td><a accesskey="n" href="NMDeviceModem.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#NMDeviceInfiniband.synopsis" class="shortcut">Top</a> - | - <a href="#NMDeviceInfiniband.description" class="shortcut">Description</a> - | - <a href="#NMDeviceInfiniband.object-hierarchy" class="shortcut">Object Hierarchy</a> - | - <a href="#NMDeviceInfiniband.implemented-interfaces" class="shortcut">Implemented Interfaces</a> - | - <a href="#NMDeviceInfiniband.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="#NMDeviceInfiniband.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#NMDeviceInfiniband.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#NMDeviceInfiniband.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="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="NMDeviceGeneric.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="NMDeviceModem.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> <div class="refentry"> <a name="NMDeviceInfiniband"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -39,38 +31,82 @@ <h2><span class="refentrytitle"><a name="NMDeviceInfiniband.top_of_page"></a>NMDeviceInfiniband</span></h2> <p>NMDeviceInfiniband</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="NMDeviceInfiniband.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis">#define <a class="link" href="NMDeviceInfiniband.html#NM-DEVICE-INFINIBAND-HW-ADDRESS:CAPS" title="NM_DEVICE_INFINIBAND_HW_ADDRESS">NM_DEVICE_INFINIBAND_HW_ADDRESS</a> -#define <a class="link" href="NMDeviceInfiniband.html#NM-DEVICE-INFINIBAND-CARRIER:CAPS" title="NM_DEVICE_INFINIBAND_CARRIER">NM_DEVICE_INFINIBAND_CARRIER</a> -struct <a class="link" href="NMDeviceInfiniband.html#NMDeviceInfiniband-struct" title="struct NMDeviceInfiniband">NMDeviceInfiniband</a>; - <a class="link" href="NMDeviceInfiniband.html#NMDeviceInfinibandClass" title="NMDeviceInfinibandClass">NMDeviceInfinibandClass</a>; -const <span class="returnvalue">char</span> * <a class="link" href="NMDeviceInfiniband.html#nm-device-infiniband-get-hw-address" title="nm_device_infiniband_get_hw_address ()">nm_device_infiniband_get_hw_address</a> (<em class="parameter"><code><a class="link" href="NMDeviceInfiniband.html" title="NMDeviceInfiniband"><span class="type">NMDeviceInfiniband</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="NMDeviceInfiniband.html#nm-device-infiniband-get-carrier" title="nm_device_infiniband_get_carrier ()">nm_device_infiniband_get_carrier</a> (<em class="parameter"><code><a class="link" href="NMDeviceInfiniband.html" title="NMDeviceInfiniband"><span class="type">NMDeviceInfiniband</span></a> *device</code></em>); -</pre> +<div class="refsect1"> +<a name="NMDeviceInfiniband.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">const <span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="NMDeviceInfiniband.html#nm-device-infiniband-get-hw-address" title="nm_device_infiniband_get_hw_address ()">nm_device_infiniband_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="NMDeviceInfiniband.html#nm-device-infiniband-get-carrier" title="nm_device_infiniband_get_carrier ()">nm_device_infiniband_get_carrier</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> </div> <div class="refsect1"> -<a name="NMDeviceInfiniband.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> - +----NMDeviceInfiniband -</pre> +<a name="NMDeviceInfiniband.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="NMDeviceInfiniband.html#NMDeviceInfiniband--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="NMDeviceInfiniband.html#NMDeviceInfiniband--hw-address" title="The “hw-address” property">hw-address</a></td> +<td class="property_flags">Read</td> +</tr> +</tbody> +</table></div> </div> <div class="refsect1"> -<a name="NMDeviceInfiniband.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -NMDeviceInfiniband 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="NMDeviceInfiniband.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="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMDeviceInfiniband.html#NM-DEVICE-INFINIBAND-HW-ADDRESS:CAPS" title="NM_DEVICE_INFINIBAND_HW_ADDRESS">NM_DEVICE_INFINIBAND_HW_ADDRESS</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMDeviceInfiniband.html#NM-DEVICE-INFINIBAND-CARRIER:CAPS" title="NM_DEVICE_INFINIBAND_CARRIER">NM_DEVICE_INFINIBAND_CARRIER</a></td> +</tr> +</tbody> +</table></div> </div> <div class="refsect1"> -<a name="NMDeviceInfiniband.properties"></a><h2>Properties</h2> -<pre class="synopsis"> - "<a class="link" href="NMDeviceInfiniband.html#NMDeviceInfiniband--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="NMDeviceInfiniband.html#NMDeviceInfiniband--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 name="NMDeviceInfiniband.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> NMDeviceInfiniband </pre> </div> <div class="refsect1"> @@ -79,115 +115,101 @@ NMDeviceInfiniband implements </p> </div> <div class="refsect1"> -<a name="NMDeviceInfiniband.details"></a><h2>Details</h2> +<a name="NMDeviceInfiniband.functions_details"></a><h2>Functions</h2> <div class="refsect2"> -<a name="NM-DEVICE-INFINIBAND-HW-ADDRESS:CAPS"></a><h3>NM_DEVICE_INFINIBAND_HW_ADDRESS</h3> -<pre class="programlisting">#define NM_DEVICE_INFINIBAND_HW_ADDRESS "hw-address" -</pre> -<p> -</p> +<a name="nm-device-infiniband-get-hw-address"></a><h3>nm_device_infiniband_get_hw_address ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +nm_device_infiniband_get_hw_address (<em class="parameter"><code><a class="link" href="NMDeviceInfiniband.html" title="NMDeviceInfiniband"><span class="type">NMDeviceInfiniband</span></a> *device</code></em>);</pre> +<p>Gets the hardware (MAC) address of the <a class="link" href="NMDeviceInfiniband.html" title="NMDeviceInfiniband"><span class="type">NMDeviceInfiniband</span></a></p> +<div class="refsect3"> +<a name="id-1.5.9.8.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>device</p></td> +<td class="parameter_description"><p>a <a class="link" href="NMDeviceInfiniband.html" title="NMDeviceInfiniband"><span class="type">NMDeviceInfiniband</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> </div> -<hr> -<div class="refsect2"> -<a name="NM-DEVICE-INFINIBAND-CARRIER:CAPS"></a><h3>NM_DEVICE_INFINIBAND_CARRIER</h3> -<pre class="programlisting">#define NM_DEVICE_INFINIBAND_CARRIER "carrier" -</pre> -<p> -</p> +<div class="refsect3"> +<a name="id-1.5.9.8.2.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> -<hr> -<div class="refsect2"> -<a name="NMDeviceInfiniband-struct"></a><h3>struct NMDeviceInfiniband</h3> -<pre class="programlisting">struct NMDeviceInfiniband;</pre> -<p> -</p> </div> <hr> <div class="refsect2"> -<a name="NMDeviceInfinibandClass"></a><h3>NMDeviceInfinibandClass</h3> -<pre class="programlisting">typedef struct { - NMDeviceClass parent; -} NMDeviceInfinibandClass; -</pre> -<p> -</p> +<a name="nm-device-infiniband-get-carrier"></a><h3>nm_device_infiniband_get_carrier ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +nm_device_infiniband_get_carrier (<em class="parameter"><code><a class="link" href="NMDeviceInfiniband.html" title="NMDeviceInfiniband"><span class="type">NMDeviceInfiniband</span></a> *device</code></em>);</pre> +<p>Whether the device has carrier.</p> +<div class="refsect3"> +<a name="id-1.5.9.8.3.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="NMDeviceInfiniband.html" title="NMDeviceInfiniband"><span class="type">NMDeviceInfiniband</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> </div> -<hr> +<div class="refsect3"> +<a name="id-1.5.9.8.3.6"></a><h4>Returns</h4> +<p> <code class="literal">TRUE</code> if the device has carrier</p> +<p></p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="NMDeviceInfiniband.other_details"></a><h2>Types and Values</h2> <div class="refsect2"> -<a name="nm-device-infiniband-get-hw-address"></a><h3>nm_device_infiniband_get_hw_address ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * nm_device_infiniband_get_hw_address (<em class="parameter"><code><a class="link" href="NMDeviceInfiniband.html" title="NMDeviceInfiniband"><span class="type">NMDeviceInfiniband</span></a> *device</code></em>);</pre> +<a name="NM-DEVICE-INFINIBAND-HW-ADDRESS:CAPS"></a><h3>NM_DEVICE_INFINIBAND_HW_ADDRESS</h3> +<pre class="programlisting">#define NM_DEVICE_INFINIBAND_HW_ADDRESS "hw-address" +</pre> <p> -Gets the hardware (MAC) address of the <a class="link" href="NMDeviceInfiniband.html" title="NMDeviceInfiniband"><span class="type">NMDeviceInfiniband</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="NMDeviceInfiniband.html" title="NMDeviceInfiniband"><span class="type">NMDeviceInfiniband</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> </div> <hr> <div class="refsect2"> -<a name="nm-device-infiniband-get-carrier"></a><h3>nm_device_infiniband_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_infiniband_get_carrier (<em class="parameter"><code><a class="link" href="NMDeviceInfiniband.html" title="NMDeviceInfiniband"><span class="type">NMDeviceInfiniband</span></a> *device</code></em>);</pre> +<a name="NM-DEVICE-INFINIBAND-CARRIER:CAPS"></a><h3>NM_DEVICE_INFINIBAND_CARRIER</h3> +<pre class="programlisting">#define NM_DEVICE_INFINIBAND_CARRIER "carrier" +</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="NMDeviceInfiniband.html" title="NMDeviceInfiniband"><span class="type">NMDeviceInfiniband</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> </div> </div> <div class="refsect1"> <a name="NMDeviceInfiniband.property-details"></a><h2>Property Details</h2> <div class="refsect2"> -<a name="NMDeviceInfiniband--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="NMDeviceInfiniband--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> </div> <hr> <div class="refsect2"> -<a name="NMDeviceInfiniband--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="NMDeviceInfiniband--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> </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 |