diff options
Diffstat (limited to 'docs/libnm/html/libnm-NMSettingInfiniband.html')
| -rw-r--r-- | docs/libnm/html/libnm-NMSettingInfiniband.html | 354 |
1 files changed, 354 insertions, 0 deletions
diff --git a/docs/libnm/html/libnm-NMSettingInfiniband.html b/docs/libnm/html/libnm-NMSettingInfiniband.html new file mode 100644 index 00000000..66b8471c --- /dev/null +++ b/docs/libnm/html/libnm-NMSettingInfiniband.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>NMSettingInfiniband: libnm Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> +<link rel="home" href="index.html" title="libnm Reference Manual"> +<link rel="up" href="ch03.html" title="Connection and Setting API Reference"> +<link rel="prev" href="libnm-NMSettingHostname.html" title="NMSettingHostname"> +<link rel="next" href="libnm-NMSettingIPConfig.html" title="NMSettingIPConfig"> +<meta name="generator" content="GTK-Doc V1.33.1 (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="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="#libnm-NMSettingInfiniband.description" class="shortcut">Description</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="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="libnm-NMSettingHostname.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="libnm-NMSettingIPConfig.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="libnm-NMSettingInfiniband"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libnm-NMSettingInfiniband.top_of_page"></a>NMSettingInfiniband</span></h2> +<p>NMSettingInfiniband — Describes connection properties for IP-over-InfiniBand networks</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="libnm-NMSettingInfiniband.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_proto_type"> +<col class="functions_proto_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a href="/usr/share/gtk-doc/html/libnm-util/NMSetting.html#NMSetting-struct"><span class="returnvalue">NMSetting</span></a> * +</td> +<td class="function_name"> +<a class="link" href="libnm-NMSettingInfiniband.html#nm-setting-infiniband-new" title="nm_setting_infiniband_new ()">nm_setting_infiniband_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="libnm-NMSettingInfiniband.html#nm-setting-infiniband-get-mac-address" title="nm_setting_infiniband_get_mac_address ()">nm_setting_infiniband_get_mac_address</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> +</td> +<td class="function_name"> +<a class="link" href="libnm-NMSettingInfiniband.html#nm-setting-infiniband-get-mtu" title="nm_setting_infiniband_get_mtu ()">nm_setting_infiniband_get_mtu</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="libnm-NMSettingInfiniband.html#nm-setting-infiniband-get-transport-mode" title="nm_setting_infiniband_get_transport_mode ()">nm_setting_infiniband_get_transport_mode</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">int</span> +</td> +<td class="function_name"> +<a class="link" href="libnm-NMSettingInfiniband.html#nm-setting-infiniband-get-p-key" title="nm_setting_infiniband_get_p_key ()">nm_setting_infiniband_get_p_key</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="libnm-NMSettingInfiniband.html#nm-setting-infiniband-get-parent" title="nm_setting_infiniband_get_parent ()">nm_setting_infiniband_get_parent</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="libnm-NMSettingInfiniband.html#nm-setting-infiniband-get-virtual-interface-name" title="nm_setting_infiniband_get_virtual_interface_name ()">nm_setting_infiniband_get_virtual_interface_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="libnm-NMSettingInfiniband.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="other_proto_type"> +<col class="other_proto_name"> +</colgroup> +<tbody> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="libnm-NMSettingInfiniband.html#NM-SETTING-INFINIBAND-SETTING-NAME:CAPS" title="NM_SETTING_INFINIBAND_SETTING_NAME">NM_SETTING_INFINIBAND_SETTING_NAME</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="libnm-NMSettingInfiniband.html#NM-SETTING-INFINIBAND-MAC-ADDRESS:CAPS" title="NM_SETTING_INFINIBAND_MAC_ADDRESS">NM_SETTING_INFINIBAND_MAC_ADDRESS</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="libnm-NMSettingInfiniband.html#NM-SETTING-INFINIBAND-MTU:CAPS" title="NM_SETTING_INFINIBAND_MTU">NM_SETTING_INFINIBAND_MTU</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="libnm-NMSettingInfiniband.html#NM-SETTING-INFINIBAND-TRANSPORT-MODE:CAPS" title="NM_SETTING_INFINIBAND_TRANSPORT_MODE">NM_SETTING_INFINIBAND_TRANSPORT_MODE</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="libnm-NMSettingInfiniband.html#NM-SETTING-INFINIBAND-P-KEY:CAPS" title="NM_SETTING_INFINIBAND_P_KEY">NM_SETTING_INFINIBAND_P_KEY</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="libnm-NMSettingInfiniband.html#NM-SETTING-INFINIBAND-PARENT:CAPS" title="NM_SETTING_INFINIBAND_PARENT">NM_SETTING_INFINIBAND_PARENT</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="libnm-NMSettingInfiniband.description"></a><h2>Description</h2> +<p>The <span class="type">NMSettingInfiniband</span> object is a <a href="/usr/share/gtk-doc/html/libnm-util/NMSetting.html#NMSetting-struct"><span class="type">NMSetting</span></a> subclass that describes properties +necessary for connection to IP-over-InfiniBand networks.</p> +</div> +<div class="refsect1"> +<a name="libnm-NMSettingInfiniband.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="nm-setting-infiniband-new"></a><h3>nm_setting_infiniband_new ()</h3> +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/libnm-util/NMSetting.html#NMSetting-struct"><span class="returnvalue">NMSetting</span></a> * +nm_setting_infiniband_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p>Creates a new <span class="type">NMSettingInfiniband</span> object with default values.</p> +<div class="refsect3"> +<a name="nm-setting-infiniband-new.returns"></a><h4>Returns</h4> +<p>the new empty <span class="type">NMSettingInfiniband</span> object. </p> +<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-infiniband-get-mac-address"></a><h3>nm_setting_infiniband_get_mac_address ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +nm_setting_infiniband_get_mac_address (<em class="parameter"><code><span class="type">NMSettingInfiniband</span> *setting</code></em>);</pre> +<div class="refsect3"> +<a name="nm-setting-infiniband-get-mac-address.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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>setting</p></td> +<td class="parameter_description"><p>the <span class="type">NMSettingInfiniband</span></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="nm-setting-infiniband-get-mac-address.returns"></a><h4>Returns</h4> +<p> the <a href="/usr/share/gtk-doc/html/libnm-util/NMSettingInfiniband.html#NMSettingInfiniband--mac-address"><span class="type">“mac-address”</span></a> property of the setting</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-infiniband-get-mtu"></a><h3>nm_setting_infiniband_get_mtu ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> +nm_setting_infiniband_get_mtu (<em class="parameter"><code><span class="type">NMSettingInfiniband</span> *setting</code></em>);</pre> +<div class="refsect3"> +<a name="nm-setting-infiniband-get-mtu.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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>setting</p></td> +<td class="parameter_description"><p>the <span class="type">NMSettingInfiniband</span></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="nm-setting-infiniband-get-mtu.returns"></a><h4>Returns</h4> +<p> the <a href="/usr/share/gtk-doc/html/libnm-util/NMSettingInfiniband.html#NMSettingInfiniband--mtu"><span class="type">“mtu”</span></a> property of the setting</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-infiniband-get-transport-mode"></a><h3>nm_setting_infiniband_get_transport_mode ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +nm_setting_infiniband_get_transport_mode + (<em class="parameter"><code><span class="type">NMSettingInfiniband</span> *setting</code></em>);</pre> +<p>Returns the transport mode for this device. Either 'datagram' or +'connected'.</p> +<div class="refsect3"> +<a name="nm-setting-infiniband-get-transport-mode.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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>setting</p></td> +<td class="parameter_description"><p>the <span class="type">NMSettingInfiniband</span></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="nm-setting-infiniband-get-transport-mode.returns"></a><h4>Returns</h4> +<p> the IPoIB transport mode</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-infiniband-get-p-key"></a><h3>nm_setting_infiniband_get_p_key ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> +nm_setting_infiniband_get_p_key (<em class="parameter"><code><span class="type">NMSettingInfiniband</span> *setting</code></em>);</pre> +<p>Returns the P_Key to use for this device. A value of -1 means to +use the default P_Key (aka "the P_Key at index 0"). Otherwise, it is +a 16-bit unsigned integer.</p> +<div class="refsect3"> +<a name="nm-setting-infiniband-get-p-key.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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>setting</p></td> +<td class="parameter_description"><p>the <span class="type">NMSettingInfiniband</span></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="nm-setting-infiniband-get-p-key.returns"></a><h4>Returns</h4> +<p> the IPoIB P_Key</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-infiniband-get-parent"></a><h3>nm_setting_infiniband_get_parent ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +nm_setting_infiniband_get_parent (<em class="parameter"><code><span class="type">NMSettingInfiniband</span> *setting</code></em>);</pre> +<p>Returns the parent interface name for this device, if set.</p> +<div class="refsect3"> +<a name="nm-setting-infiniband-get-parent.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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>setting</p></td> +<td class="parameter_description"><p>the <span class="type">NMSettingInfiniband</span></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="nm-setting-infiniband-get-parent.returns"></a><h4>Returns</h4> +<p> the parent interface name</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-infiniband-get-virtual-interface-name"></a><h3>nm_setting_infiniband_get_virtual_interface_name ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +nm_setting_infiniband_get_virtual_interface_name + (<em class="parameter"><code><span class="type">NMSettingInfiniband</span> *setting</code></em>);</pre> +<p>Returns the interface name created by combining <a href="/usr/share/gtk-doc/html/libnm-util/NMSettingInfiniband.html#NMSettingInfiniband--parent"><span class="type">“parent”</span></a> +and <a href="/usr/share/gtk-doc/html/libnm-util/NMSettingInfiniband.html#NMSettingInfiniband--p-key"><span class="type">“p-key”</span></a>. (If either property is unset, this will +return <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.)</p> +<div class="refsect3"> +<a name="nm-setting-infiniband-get-virtual-interface-name.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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>setting</p></td> +<td class="parameter_description"><p>the <span class="type">NMSettingInfiniband</span></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="nm-setting-infiniband-get-virtual-interface-name.returns"></a><h4>Returns</h4> +<p> the interface name, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="libnm-NMSettingInfiniband.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="NM-SETTING-INFINIBAND-SETTING-NAME:CAPS"></a><h3>NM_SETTING_INFINIBAND_SETTING_NAME</h3> +<pre class="programlisting">#define NM_SETTING_INFINIBAND_SETTING_NAME "infiniband" +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-INFINIBAND-MAC-ADDRESS:CAPS"></a><h3>NM_SETTING_INFINIBAND_MAC_ADDRESS</h3> +<pre class="programlisting">#define NM_SETTING_INFINIBAND_MAC_ADDRESS "mac-address" +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-INFINIBAND-MTU:CAPS"></a><h3>NM_SETTING_INFINIBAND_MTU</h3> +<pre class="programlisting">#define NM_SETTING_INFINIBAND_MTU "mtu" +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-INFINIBAND-TRANSPORT-MODE:CAPS"></a><h3>NM_SETTING_INFINIBAND_TRANSPORT_MODE</h3> +<pre class="programlisting">#define NM_SETTING_INFINIBAND_TRANSPORT_MODE "transport-mode" +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-INFINIBAND-P-KEY:CAPS"></a><h3>NM_SETTING_INFINIBAND_P_KEY</h3> +<pre class="programlisting">#define NM_SETTING_INFINIBAND_P_KEY "p-key" +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-INFINIBAND-PARENT:CAPS"></a><h3>NM_SETTING_INFINIBAND_PARENT</h3> +<pre class="programlisting">#define NM_SETTING_INFINIBAND_PARENT "parent" +</pre> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.33.1</div> +</body> +</html> \ No newline at end of file |