diff options
Diffstat (limited to 'docs/libnm-util/html/NMSettingBridgePort.html')
| -rw-r--r-- | docs/libnm-util/html/NMSettingBridgePort.html | 314 |
1 files changed, 314 insertions, 0 deletions
diff --git a/docs/libnm-util/html/NMSettingBridgePort.html b/docs/libnm-util/html/NMSettingBridgePort.html new file mode 100644 index 00000000..e5ce3b47 --- /dev/null +++ b/docs/libnm-util/html/NMSettingBridgePort.html @@ -0,0 +1,314 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>NMSettingBridgePort</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="libnm-util Reference Manual"> +<link rel="up" href="ch01.html" title="libnm-util API Reference"> +<link rel="prev" href="NMSettingBridge.html" title="NMSettingBridge"> +<link rel="next" href="NMSettingInfiniband.html" title="NMSettingInfiniband"> +<meta name="generator" content="GTK-Doc V1.18 (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="NMSettingBridge.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-util Reference Manual</th> +<td><a accesskey="n" href="NMSettingInfiniband.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#NMSettingBridgePort.synopsis" class="shortcut">Top</a> + | + <a href="#NMSettingBridgePort.description" class="shortcut">Description</a> + | + <a href="#NMSettingBridgePort.object-hierarchy" class="shortcut">Object Hierarchy</a> + | + <a href="#NMSettingBridgePort.properties" class="shortcut">Properties</a> +</td></tr> +</table> +<div class="refentry"> +<a name="NMSettingBridgePort"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="NMSettingBridgePort.top_of_page"></a>NMSettingBridgePort</span></h2> +<p>NMSettingBridgePort — Describes connection properties for bridge ports</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="NMSettingBridgePort.synopsis"></a><h2>Synopsis</h2> +<a name="NMSettingBridgePortError"></a><pre class="synopsis"> +#include <nm-setting-bridge-port.h> + + <a class="link" href="NMSettingBridgePort.html#NMSettingBridgePort-struct" title="NMSettingBridgePort">NMSettingBridgePort</a>; + <a class="link" href="NMSettingBridgePort.html#NMSettingBridgePortClass" title="NMSettingBridgePortClass">NMSettingBridgePortClass</a>; +enum <a class="link" href="NMSettingBridgePort.html#NMSettingBridgePortError-enum" title="enum NMSettingBridgePortError">NMSettingBridgePortError</a>; +#define <a class="link" href="NMSettingBridgePort.html#NM-SETTING-BRIDGE-PORT-ERROR:CAPS" title="NM_SETTING_BRIDGE_PORT_ERROR">NM_SETTING_BRIDGE_PORT_ERROR</a> +#define <a class="link" href="NMSettingBridgePort.html#NM-SETTING-BRIDGE-PORT-HAIRPIN-MODE:CAPS" title="NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE">NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE</a> +#define <a class="link" href="NMSettingBridgePort.html#NM-SETTING-BRIDGE-PORT-PATH-COST:CAPS" title="NM_SETTING_BRIDGE_PORT_PATH_COST">NM_SETTING_BRIDGE_PORT_PATH_COST</a> +#define <a class="link" href="NMSettingBridgePort.html#NM-SETTING-BRIDGE-PORT-PRIORITY:CAPS" title="NM_SETTING_BRIDGE_PORT_PRIORITY">NM_SETTING_BRIDGE_PORT_PRIORITY</a> +#define <a class="link" href="NMSettingBridgePort.html#NM-SETTING-BRIDGE-PORT-SETTING-NAME:CAPS" title="NM_SETTING_BRIDGE_PORT_SETTING_NAME">NM_SETTING_BRIDGE_PORT_SETTING_NAME</a> +<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> <a class="link" href="NMSettingBridgePort.html#nm-setting-bridge-port-error-quark" title="nm_setting_bridge_port_error_quark ()">nm_setting_bridge_port_error_quark</a> (<em class="parameter"><code><span class="type">void</span></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="NMSettingBridgePort.html#nm-setting-bridge-port-get-hairpin-mode" title="nm_setting_bridge_port_get_hairpin_mode ()">nm_setting_bridge_port_get_hairpin_mode</a> + (<em class="parameter"><code><a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</span></a> *setting</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint16"><span class="returnvalue">guint16</span></a> <a class="link" href="NMSettingBridgePort.html#nm-setting-bridge-port-get-path-cost" title="nm_setting_bridge_port_get_path_cost ()">nm_setting_bridge_port_get_path_cost</a> + (<em class="parameter"><code><a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</span></a> *setting</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint16"><span class="returnvalue">guint16</span></a> <a class="link" href="NMSettingBridgePort.html#nm-setting-bridge-port-get-priority" title="nm_setting_bridge_port_get_priority ()">nm_setting_bridge_port_get_priority</a> (<em class="parameter"><code><a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</span></a> *setting</code></em>); +<a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * <a class="link" href="NMSettingBridgePort.html#nm-setting-bridge-port-new" title="nm_setting_bridge_port_new ()">nm_setting_bridge_port_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="NMSettingBridgePort.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="NMSetting.html" title="NMSetting">NMSetting</a> + +----NMSettingBridgePort +</pre> +<pre class="synopsis"> + GEnum + +----NMSettingBridgePortError +</pre> +</div> +<div class="refsect1"> +<a name="NMSettingBridgePort.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="NMSettingBridgePort.html#NMSettingBridgePort--hairpin-mode" title='The "hairpin-mode" property'>hairpin-mode</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write + "<a class="link" href="NMSettingBridgePort.html#NMSettingBridgePort--path-cost" title='The "path-cost" property'>path-cost</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct + "<a class="link" href="NMSettingBridgePort.html#NMSettingBridgePort--priority" title='The "priority" property'>priority</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct +</pre> +</div> +<div class="refsect1"> +<a name="NMSettingBridgePort.description"></a><h2>Description</h2> +<p> +The <a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes +optional properties that apply to bridge ports. +</p> +</div> +<div class="refsect1"> +<a name="NMSettingBridgePort.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="NMSettingBridgePort-struct"></a><h3>NMSettingBridgePort</h3> +<pre class="programlisting">typedef struct _NMSettingBridgePort NMSettingBridgePort;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingBridgePortClass"></a><h3>NMSettingBridgePortClass</h3> +<pre class="programlisting">typedef struct { + NMSettingClass parent; + + /* Padding for future expansion */ + void (*_reserved1) (void); + void (*_reserved2) (void); + void (*_reserved3) (void); + void (*_reserved4) (void); +} NMSettingBridgePortClass; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingBridgePortError-enum"></a><h3>enum NMSettingBridgePortError</h3> +<pre class="programlisting">typedef enum { + NM_SETTING_BRIDGE_PORT_ERROR_UNKNOWN = 0, /*< nick=UnknownError >*/ + NM_SETTING_BRIDGE_PORT_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/ + NM_SETTING_BRIDGE_PORT_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/ +} NMSettingBridgePortError; +</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="NM-SETTING-BRIDGE-PORT-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_BRIDGE_PORT_ERROR_UNKNOWN</code></span></p></td> +<td>unknown or unclassified error +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-BRIDGE-PORT-ERROR-INVALID-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_BRIDGE_PORT_ERROR_INVALID_PROPERTY</code></span></p></td> +<td>the property was invalid +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-BRIDGE-PORT-ERROR-MISSING-PROPERTY:CAPS"></a><span class="term"><code class="literal">NM_SETTING_BRIDGE_PORT_ERROR_MISSING_PROPERTY</code></span></p></td> +<td>the property was missing and +is required +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-BRIDGE-PORT-ERROR:CAPS"></a><h3>NM_SETTING_BRIDGE_PORT_ERROR</h3> +<pre class="programlisting">#define NM_SETTING_BRIDGE_PORT_ERROR nm_setting_bridge_port_error_quark () +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-BRIDGE-PORT-HAIRPIN-MODE:CAPS"></a><h3>NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE</h3> +<pre class="programlisting">#define NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE "hairpin-mode" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-BRIDGE-PORT-PATH-COST:CAPS"></a><h3>NM_SETTING_BRIDGE_PORT_PATH_COST</h3> +<pre class="programlisting">#define NM_SETTING_BRIDGE_PORT_PATH_COST "path-cost" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-BRIDGE-PORT-PRIORITY:CAPS"></a><h3>NM_SETTING_BRIDGE_PORT_PRIORITY</h3> +<pre class="programlisting">#define NM_SETTING_BRIDGE_PORT_PRIORITY "priority" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-BRIDGE-PORT-SETTING-NAME:CAPS"></a><h3>NM_SETTING_BRIDGE_PORT_SETTING_NAME</h3> +<pre class="programlisting">#define NM_SETTING_BRIDGE_PORT_SETTING_NAME "bridge-port" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-bridge-port-error-quark"></a><h3>nm_setting_bridge_port_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_setting_bridge_port_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Registers an error quark for <a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</span></a> if necessary. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<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="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</span></a> errors.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-bridge-port-get-hairpin-mode"></a><h3>nm_setting_bridge_port_get_hairpin_mode ()</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_setting_bridge_port_get_hairpin_mode + (<em class="parameter"><code><a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</span></a> *setting</code></em>);</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td> +<td>the <a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</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="NMSettingBridgePort.html#NMSettingBridgePort--hairpin-mode" title='The "hairpin-mode" property'><span class="type">"hairpin-mode"</span></a> property of the setting</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-bridge-port-get-path-cost"></a><h3>nm_setting_bridge_port_get_path_cost ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint16"><span class="returnvalue">guint16</span></a> nm_setting_bridge_port_get_path_cost + (<em class="parameter"><code><a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</span></a> *setting</code></em>);</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td> +<td>the <a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</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="NMSettingBridgePort.html#NMSettingBridgePort--path-cost" title='The "path-cost" property'><span class="type">"path-cost"</span></a> property of the setting</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-bridge-port-get-priority"></a><h3>nm_setting_bridge_port_get_priority ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint16"><span class="returnvalue">guint16</span></a> nm_setting_bridge_port_get_priority (<em class="parameter"><code><a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</span></a> *setting</code></em>);</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td> +<td>the <a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</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="NMSettingBridgePort.html#NMSettingBridgePort--priority" title='The "priority" property'><span class="type">"priority"</span></a> property of the setting</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-bridge-port-new"></a><h3>nm_setting_bridge_port_new ()</h3> +<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_bridge_port_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new <a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</span></a> object with default values. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the new empty <a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</span></a> object. <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> +</div> +</div> +<div class="refsect1"> +<a name="NMSettingBridgePort.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="NMSettingBridgePort--hairpin-mode"></a><h3>The <code class="literal">"hairpin-mode"</code> property</h3> +<pre class="programlisting"> "hairpin-mode" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre> +<p> +Enables or disabled 'hairpin mode' for the port, which allows frames to +be sent back out through the port the frame was received on. +</p> +<p>Default value: FALSE</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingBridgePort--path-cost"></a><h3>The <code class="literal">"path-cost"</code> property</h3> +<pre class="programlisting"> "path-cost" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct</pre> +<p> +The Spanning Tree Protocol (STP) port cost for destinations via this port. +</p> +<p>Allowed values: <= 65535</p> +<p>Default value: 100</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingBridgePort--priority"></a><h3>The <code class="literal">"priority"</code> property</h3> +<pre class="programlisting"> "priority" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct</pre> +<p> +The Spanning Tree Protocol (STP) priority of this bridge port. +</p> +<p>Allowed values: <= 63</p> +<p>Default value: 32</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html> \ No newline at end of file |