diff options
Diffstat (limited to 'docs/libnm/html/NMSettingBridge.html')
| -rw-r--r-- | docs/libnm/html/NMSettingBridge.html | 701 |
1 files changed, 409 insertions, 292 deletions
diff --git a/docs/libnm/html/NMSettingBridge.html b/docs/libnm/html/NMSettingBridge.html index 7248b61b..addccbb4 100644 --- a/docs/libnm/html/NMSettingBridge.html +++ b/docs/libnm/html/NMSettingBridge.html @@ -2,34 +2,28 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>NMSettingBridge</title> +<title>libnm Reference Manual: NMSettingBridge</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="ch03.html" title="Connection and Setting API Reference"> <link rel="prev" href="NMSettingBond.html" title="NMSettingBond"> <link rel="next" href="NMSettingBridgePort.html" title="NMSettingBridgePort"> -<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="NMSettingBond.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="ch03.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="NMSettingBridgePort.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#NMSettingBridge.synopsis" class="shortcut">Top</a> - | - <a href="#NMSettingBridge.description" class="shortcut">Description</a> - | - <a href="#NMSettingBridge.object-hierarchy" class="shortcut">Object Hierarchy</a> - | - <a href="#NMSettingBridge.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="#NMSettingBridge.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#NMSettingBridge.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#NMSettingBridge.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="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="NMSettingBond.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="NMSettingBridgePort.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> <div class="refentry"> <a name="NMSettingBridge"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -37,59 +31,383 @@ <h2><span class="refentrytitle"><a name="NMSettingBridge.top_of_page"></a>NMSettingBridge</span></h2> <p>NMSettingBridge — Describes connection properties for bridges</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="NMSettingBridge.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis">#define <a class="link" href="NMSettingBridge.html#NM-SETTING-BRIDGE-SETTING-NAME:CAPS" title="NM_SETTING_BRIDGE_SETTING_NAME">NM_SETTING_BRIDGE_SETTING_NAME</a> -#define <a class="link" href="NMSettingBridge.html#NM-SETTING-BRIDGE-MAC-ADDRESS:CAPS" title="NM_SETTING_BRIDGE_MAC_ADDRESS">NM_SETTING_BRIDGE_MAC_ADDRESS</a> -#define <a class="link" href="NMSettingBridge.html#NM-SETTING-BRIDGE-STP:CAPS" title="NM_SETTING_BRIDGE_STP">NM_SETTING_BRIDGE_STP</a> -#define <a class="link" href="NMSettingBridge.html#NM-SETTING-BRIDGE-PRIORITY:CAPS" title="NM_SETTING_BRIDGE_PRIORITY">NM_SETTING_BRIDGE_PRIORITY</a> -#define <a class="link" href="NMSettingBridge.html#NM-SETTING-BRIDGE-FORWARD-DELAY:CAPS" title="NM_SETTING_BRIDGE_FORWARD_DELAY">NM_SETTING_BRIDGE_FORWARD_DELAY</a> -#define <a class="link" href="NMSettingBridge.html#NM-SETTING-BRIDGE-HELLO-TIME:CAPS" title="NM_SETTING_BRIDGE_HELLO_TIME">NM_SETTING_BRIDGE_HELLO_TIME</a> -#define <a class="link" href="NMSettingBridge.html#NM-SETTING-BRIDGE-MAX-AGE:CAPS" title="NM_SETTING_BRIDGE_MAX_AGE">NM_SETTING_BRIDGE_MAX_AGE</a> -#define <a class="link" href="NMSettingBridge.html#NM-SETTING-BRIDGE-AGEING-TIME:CAPS" title="NM_SETTING_BRIDGE_AGEING_TIME">NM_SETTING_BRIDGE_AGEING_TIME</a> -struct <a class="link" href="NMSettingBridge.html#NMSettingBridge-struct" title="struct NMSettingBridge">NMSettingBridge</a>; - <a class="link" href="NMSettingBridge.html#NMSettingBridgeClass" title="NMSettingBridgeClass">NMSettingBridgeClass</a>; -<a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * <a class="link" href="NMSettingBridge.html#nm-setting-bridge-new" title="nm_setting_bridge_new ()">nm_setting_bridge_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); -const <span class="returnvalue">char</span> * <a class="link" href="NMSettingBridge.html#nm-setting-bridge-get-mac-address" title="nm_setting_bridge_get_mac_address ()">nm_setting_bridge_get_mac_address</a> (<em class="parameter"><code><a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> *setting</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="NMSettingBridge.html#nm-setting-bridge-get-stp" title="nm_setting_bridge_get_stp ()">nm_setting_bridge_get_stp</a> (<em class="parameter"><code><a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</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="NMSettingBridge.html#nm-setting-bridge-get-priority" title="nm_setting_bridge_get_priority ()">nm_setting_bridge_get_priority</a> (<em class="parameter"><code><a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</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="NMSettingBridge.html#nm-setting-bridge-get-forward-delay" title="nm_setting_bridge_get_forward_delay ()">nm_setting_bridge_get_forward_delay</a> (<em class="parameter"><code><a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</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="NMSettingBridge.html#nm-setting-bridge-get-hello-time" title="nm_setting_bridge_get_hello_time ()">nm_setting_bridge_get_hello_time</a> (<em class="parameter"><code><a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</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="NMSettingBridge.html#nm-setting-bridge-get-max-age" title="nm_setting_bridge_get_max_age ()">nm_setting_bridge_get_max_age</a> (<em class="parameter"><code><a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> *setting</code></em>); -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> <a class="link" href="NMSettingBridge.html#nm-setting-bridge-get-ageing-time" title="nm_setting_bridge_get_ageing_time ()">nm_setting_bridge_get_ageing_time</a> (<em class="parameter"><code><a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> *setting</code></em>); -</pre> -</div> <div class="refsect1"> -<a name="NMSettingBridge.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> - +----NMSettingBridge -</pre> +<a name="NMSettingBridge.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"> +<a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * +</td> +<td class="function_name"> +<a class="link" href="NMSettingBridge.html#nm-setting-bridge-new" title="nm_setting_bridge_new ()">nm_setting_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="NMSettingBridge.html#nm-setting-bridge-get-mac-address" title="nm_setting_bridge_get_mac_address ()">nm_setting_bridge_get_mac_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="NMSettingBridge.html#nm-setting-bridge-get-stp" title="nm_setting_bridge_get_stp ()">nm_setting_bridge_get_stp</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">guint16</span> +</td> +<td class="function_name"> +<a class="link" href="NMSettingBridge.html#nm-setting-bridge-get-priority" title="nm_setting_bridge_get_priority ()">nm_setting_bridge_get_priority</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">guint16</span> +</td> +<td class="function_name"> +<a class="link" href="NMSettingBridge.html#nm-setting-bridge-get-forward-delay" title="nm_setting_bridge_get_forward_delay ()">nm_setting_bridge_get_forward_delay</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">guint16</span> +</td> +<td class="function_name"> +<a class="link" href="NMSettingBridge.html#nm-setting-bridge-get-hello-time" title="nm_setting_bridge_get_hello_time ()">nm_setting_bridge_get_hello_time</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">guint16</span> +</td> +<td class="function_name"> +<a class="link" href="NMSettingBridge.html#nm-setting-bridge-get-max-age" title="nm_setting_bridge_get_max_age ()">nm_setting_bridge_get_max_age</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">guint32</span> +</td> +<td class="function_name"> +<a class="link" href="NMSettingBridge.html#nm-setting-bridge-get-ageing-time" title="nm_setting_bridge_get_ageing_time ()">nm_setting_bridge_get_ageing_time</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> </div> <div class="refsect1"> <a name="NMSettingBridge.properties"></a><h2>Properties</h2> -<pre class="synopsis"> - "<a class="link" href="NMSettingBridge.html#NMSettingBridge--ageing-time" title='The "ageing-time" property'>ageing-time</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="NMSettingBridge.html#NMSettingBridge--forward-delay" title='The "forward-delay" property'>forward-delay</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="NMSettingBridge.html#NMSettingBridge--hello-time" title='The "hello-time" property'>hello-time</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="NMSettingBridge.html#NMSettingBridge--mac-address" title='The "mac-address" property'>mac-address</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write - "<a class="link" href="NMSettingBridge.html#NMSettingBridge--max-age" title='The "max-age" property'>max-age</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="NMSettingBridge.html#NMSettingBridge--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 - "<a class="link" href="NMSettingBridge.html#NMSettingBridge--stp" title='The "stp" property'>stp</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct +<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">guint</span></td> +<td class="property_name"><a class="link" href="NMSettingBridge.html#NMSettingBridge--ageing-time" title="The “ageing-time” property">ageing-time</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><span class="type">guint</span></td> +<td class="property_name"><a class="link" href="NMSettingBridge.html#NMSettingBridge--forward-delay" title="The “forward-delay” property">forward-delay</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><span class="type">guint</span></td> +<td class="property_name"><a class="link" href="NMSettingBridge.html#NMSettingBridge--hello-time" title="The “hello-time” property">hello-time</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"> +<span class="type">gchar</span> *</td> +<td class="property_name"><a class="link" href="NMSettingBridge.html#NMSettingBridge--mac-address" title="The “mac-address” property">mac-address</a></td> +<td class="property_flags">Read / Write</td> +</tr> +<tr> +<td class="property_type"><span class="type">guint</span></td> +<td class="property_name"><a class="link" href="NMSettingBridge.html#NMSettingBridge--max-age" title="The “max-age” property">max-age</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><span class="type">guint</span></td> +<td class="property_name"><a class="link" href="NMSettingBridge.html#NMSettingBridge--priority" title="The “priority” property">priority</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"><span class="type">gboolean</span></td> +<td class="property_name"><a class="link" href="NMSettingBridge.html#NMSettingBridge--stp" title="The “stp” property">stp</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="NMSettingBridge.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="NMSettingBridge.html#NM-SETTING-BRIDGE-SETTING-NAME:CAPS" title="NM_SETTING_BRIDGE_SETTING_NAME">NM_SETTING_BRIDGE_SETTING_NAME</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMSettingBridge.html#NM-SETTING-BRIDGE-MAC-ADDRESS:CAPS" title="NM_SETTING_BRIDGE_MAC_ADDRESS">NM_SETTING_BRIDGE_MAC_ADDRESS</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMSettingBridge.html#NM-SETTING-BRIDGE-STP:CAPS" title="NM_SETTING_BRIDGE_STP">NM_SETTING_BRIDGE_STP</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMSettingBridge.html#NM-SETTING-BRIDGE-PRIORITY:CAPS" title="NM_SETTING_BRIDGE_PRIORITY">NM_SETTING_BRIDGE_PRIORITY</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMSettingBridge.html#NM-SETTING-BRIDGE-FORWARD-DELAY:CAPS" title="NM_SETTING_BRIDGE_FORWARD_DELAY">NM_SETTING_BRIDGE_FORWARD_DELAY</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMSettingBridge.html#NM-SETTING-BRIDGE-HELLO-TIME:CAPS" title="NM_SETTING_BRIDGE_HELLO_TIME">NM_SETTING_BRIDGE_HELLO_TIME</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMSettingBridge.html#NM-SETTING-BRIDGE-MAX-AGE:CAPS" title="NM_SETTING_BRIDGE_MAX_AGE">NM_SETTING_BRIDGE_MAX_AGE</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMSettingBridge.html#NM-SETTING-BRIDGE-AGEING-TIME:CAPS" title="NM_SETTING_BRIDGE_AGEING_TIME">NM_SETTING_BRIDGE_AGEING_TIME</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="NMSettingBridge.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> GObject + <span class="lineart">╰──</span> <a class="link" href="NMSetting.html" title="NMSetting">NMSetting</a> + <span class="lineart">╰──</span> NMSettingBridge </pre> </div> <div class="refsect1"> <a name="NMSettingBridge.description"></a><h2>Description</h2> -<p> -The <a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes properties -necessary for bridging connections. -</p> +<p>The <a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes properties +necessary for bridging connections.</p> +</div> +<div class="refsect1"> +<a name="NMSettingBridge.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="nm-setting-bridge-new"></a><h3>nm_setting_bridge_new ()</h3> +<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * +nm_setting_bridge_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p>Creates a new <a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> object with default values.</p> +<div class="refsect3"> +<a name="id-1.4.10.8.2.5"></a><h4>Returns</h4> +<p> the new empty <a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> object. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-bridge-get-mac-address"></a><h3>nm_setting_bridge_get_mac_address ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +nm_setting_bridge_get_mac_address (<em class="parameter"><code><a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> *setting</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.10.8.3.4"></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>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.10.8.3.5"></a><h4>Returns</h4> +<p> the <a class="link" href="NMSettingBridge.html#NMSettingBridge--mac-address" title="The “mac-address” property"><span class="type">“mac-address”</span></a> property of the setting</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-bridge-get-stp"></a><h3>nm_setting_bridge_get_stp ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +nm_setting_bridge_get_stp (<em class="parameter"><code><a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> *setting</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.10.8.4.4"></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>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.10.8.4.5"></a><h4>Returns</h4> +<p> the <a class="link" href="NMSettingBridge.html#NMSettingBridge--stp" title="The “stp” property"><span class="type">“stp”</span></a> property of the setting</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-bridge-get-priority"></a><h3>nm_setting_bridge_get_priority ()</h3> +<pre class="programlisting"><span class="returnvalue">guint16</span> +nm_setting_bridge_get_priority (<em class="parameter"><code><a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> *setting</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.10.8.5.4"></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>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.10.8.5.5"></a><h4>Returns</h4> +<p> the <a class="link" href="NMSettingBridge.html#NMSettingBridge--priority" title="The “priority” property"><span class="type">“priority”</span></a> property of the setting</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-bridge-get-forward-delay"></a><h3>nm_setting_bridge_get_forward_delay ()</h3> +<pre class="programlisting"><span class="returnvalue">guint16</span> +nm_setting_bridge_get_forward_delay (<em class="parameter"><code><a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> *setting</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.10.8.6.4"></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>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.10.8.6.5"></a><h4>Returns</h4> +<p> the <a class="link" href="NMSettingBridge.html#NMSettingBridge--forward-delay" title="The “forward-delay” property"><span class="type">“forward-delay”</span></a> property of the setting</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-bridge-get-hello-time"></a><h3>nm_setting_bridge_get_hello_time ()</h3> +<pre class="programlisting"><span class="returnvalue">guint16</span> +nm_setting_bridge_get_hello_time (<em class="parameter"><code><a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> *setting</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.10.8.7.4"></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>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.10.8.7.5"></a><h4>Returns</h4> +<p> the <a class="link" href="NMSettingBridge.html#NMSettingBridge--hello-time" title="The “hello-time” property"><span class="type">“hello-time”</span></a> property of the setting</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-bridge-get-max-age"></a><h3>nm_setting_bridge_get_max_age ()</h3> +<pre class="programlisting"><span class="returnvalue">guint16</span> +nm_setting_bridge_get_max_age (<em class="parameter"><code><a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> *setting</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.10.8.8.4"></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>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.10.8.8.5"></a><h4>Returns</h4> +<p> the <a class="link" href="NMSettingBridge.html#NMSettingBridge--max-age" title="The “max-age” property"><span class="type">“max-age”</span></a> property of the setting</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-bridge-get-ageing-time"></a><h3>nm_setting_bridge_get_ageing_time ()</h3> +<pre class="programlisting"><span class="returnvalue">guint32</span> +nm_setting_bridge_get_ageing_time (<em class="parameter"><code><a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> *setting</code></em>);</pre> +<div class="refsect3"> +<a name="id-1.4.10.8.9.4"></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>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.10.8.9.5"></a><h4>Returns</h4> +<p> the <a class="link" href="NMSettingBridge.html#NMSettingBridge--ageing-time" title="The “ageing-time” property"><span class="type">“ageing-time”</span></a> property of the setting</p> +<p></p> +</div> +</div> </div> <div class="refsect1"> -<a name="NMSettingBridge.details"></a><h2>Details</h2> +<a name="NMSettingBridge.other_details"></a><h2>Types and Values</h2> <div class="refsect2"> <a name="NM-SETTING-BRIDGE-SETTING-NAME:CAPS"></a><h3>NM_SETTING_BRIDGE_SETTING_NAME</h3> <pre class="programlisting">#define NM_SETTING_BRIDGE_SETTING_NAME "bridge" @@ -153,274 +471,73 @@ necessary for bridging connections. <p> </p> </div> -<hr> -<div class="refsect2"> -<a name="NMSettingBridge-struct"></a><h3>struct NMSettingBridge</h3> -<pre class="programlisting">struct NMSettingBridge;</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingBridgeClass"></a><h3>NMSettingBridgeClass</h3> -<pre class="programlisting">typedef struct { - NMSettingClass parent; -} NMSettingBridgeClass; -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="nm-setting-bridge-new"></a><h3>nm_setting_bridge_new ()</h3> -<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_bridge_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p> -Creates a new <a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> object with default values. -</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 new empty <a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</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> -<hr> -<div class="refsect2"> -<a name="nm-setting-bridge-get-mac-address"></a><h3>nm_setting_bridge_get_mac_address ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_bridge_get_mac_address (<em class="parameter"><code><a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> *setting</code></em>);</pre> -<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>setting</code></em> :</span></p></td> -<td>the <a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</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="NMSettingBridge.html#NMSettingBridge--mac-address" title='The "mac-address" property'><span class="type">"mac-address"</span></a> property of the setting</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="nm-setting-bridge-get-stp"></a><h3>nm_setting_bridge_get_stp ()</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_get_stp (<em class="parameter"><code><a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> *setting</code></em>);</pre> -<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>setting</code></em> :</span></p></td> -<td>the <a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</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="NMSettingBridge.html#NMSettingBridge--stp" title='The "stp" property'><span class="type">"stp"</span></a> property of the setting</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="nm-setting-bridge-get-priority"></a><h3>nm_setting_bridge_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_get_priority (<em class="parameter"><code><a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> *setting</code></em>);</pre> -<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>setting</code></em> :</span></p></td> -<td>the <a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</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="NMSettingBridge.html#NMSettingBridge--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-get-forward-delay"></a><h3>nm_setting_bridge_get_forward_delay ()</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_get_forward_delay (<em class="parameter"><code><a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> *setting</code></em>);</pre> -<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>setting</code></em> :</span></p></td> -<td>the <a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</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="NMSettingBridge.html#NMSettingBridge--forward-delay" title='The "forward-delay" property'><span class="type">"forward-delay"</span></a> property of the setting</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="nm-setting-bridge-get-hello-time"></a><h3>nm_setting_bridge_get_hello_time ()</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_get_hello_time (<em class="parameter"><code><a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> *setting</code></em>);</pre> -<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>setting</code></em> :</span></p></td> -<td>the <a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</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="NMSettingBridge.html#NMSettingBridge--hello-time" title='The "hello-time" property'><span class="type">"hello-time"</span></a> property of the setting</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="nm-setting-bridge-get-max-age"></a><h3>nm_setting_bridge_get_max_age ()</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_get_max_age (<em class="parameter"><code><a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> *setting</code></em>);</pre> -<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>setting</code></em> :</span></p></td> -<td>the <a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</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="NMSettingBridge.html#NMSettingBridge--max-age" title='The "max-age" property'><span class="type">"max-age"</span></a> property of the setting</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="nm-setting-bridge-get-ageing-time"></a><h3>nm_setting_bridge_get_ageing_time ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_setting_bridge_get_ageing_time (<em class="parameter"><code><a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</span></a> *setting</code></em>);</pre> -<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>setting</code></em> :</span></p></td> -<td>the <a class="link" href="NMSettingBridge.html" title="NMSettingBridge"><span class="type">NMSettingBridge</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="NMSettingBridge.html#NMSettingBridge--ageing-time" title='The "ageing-time" property'><span class="type">"ageing-time"</span></a> property of the setting</td> -</tr> -</tbody> -</table></div> -</div> </div> <div class="refsect1"> <a name="NMSettingBridge.property-details"></a><h2>Property Details</h2> <div class="refsect2"> -<a name="NMSettingBridge--ageing-time"></a><h3>The <code class="literal">"ageing-time"</code> property</h3> -<pre class="programlisting"> "ageing-time" <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 Ethernet MAC address aging time, in seconds. -</p> +<a name="NMSettingBridge--ageing-time"></a><h3>The <code class="literal">“ageing-time”</code> property</h3> +<pre class="programlisting"> “ageing-time” <span class="type">guint</span></pre> +<p></p> +<p>Flags: Read / Write / Construct</p> <p>Allowed values: <= 1000000</p> <p>Default value: 300</p> </div> <hr> <div class="refsect2"> -<a name="NMSettingBridge--forward-delay"></a><h3>The <code class="literal">"forward-delay"</code> property</h3> -<pre class="programlisting"> "forward-delay" <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) forwarding delay, in seconds. -</p> +<a name="NMSettingBridge--forward-delay"></a><h3>The <code class="literal">“forward-delay”</code> property</h3> +<pre class="programlisting"> “forward-delay” <span class="type">guint</span></pre> +<p></p> +<p>Flags: Read / Write / Construct</p> <p>Allowed values: <= 30</p> <p>Default value: 15</p> </div> <hr> <div class="refsect2"> -<a name="NMSettingBridge--hello-time"></a><h3>The <code class="literal">"hello-time"</code> property</h3> -<pre class="programlisting"> "hello-time" <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) hello time, in seconds. -</p> +<a name="NMSettingBridge--hello-time"></a><h3>The <code class="literal">“hello-time”</code> property</h3> +<pre class="programlisting"> “hello-time” <span class="type">guint</span></pre> +<p></p> +<p>Flags: Read / Write / Construct</p> <p>Allowed values: <= 10</p> <p>Default value: 2</p> </div> <hr> <div class="refsect2"> -<a name="NMSettingBridge--mac-address"></a><h3>The <code class="literal">"mac-address"</code> property</h3> -<pre class="programlisting"> "mac-address" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> -<p> -If specified, the MAC address of bridge. When creating a new bridge, this -MAC address will be set. When matching an existing (outside -NetworkManager created) bridge, this MAC address must match. -</p> +<a name="NMSettingBridge--mac-address"></a><h3>The <code class="literal">“mac-address”</code> property</h3> +<pre class="programlisting"> “mac-address” <span class="type">gchar</span> *</pre> +<p></p> +<p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> <hr> <div class="refsect2"> -<a name="NMSettingBridge--max-age"></a><h3>The <code class="literal">"max-age"</code> property</h3> -<pre class="programlisting"> "max-age" <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) maximum message age, in seconds. -</p> +<a name="NMSettingBridge--max-age"></a><h3>The <code class="literal">“max-age”</code> property</h3> +<pre class="programlisting"> “max-age” <span class="type">guint</span></pre> +<p></p> +<p>Flags: Read / Write / Construct</p> <p>Allowed values: <= 40</p> <p>Default value: 20</p> </div> <hr> <div class="refsect2"> -<a name="NMSettingBridge--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> -Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower -values are "better"; the lowest priority bridge will be elected the root -bridge. -</p> +<a name="NMSettingBridge--priority"></a><h3>The <code class="literal">“priority”</code> property</h3> +<pre class="programlisting"> “priority” <span class="type">guint</span></pre> +<p></p> +<p>Flags: Read / Write / Construct</p> <p>Allowed values: <= 65535</p> <p>Default value: 32768</p> </div> <hr> <div class="refsect2"> -<a name="NMSettingBridge--stp"></a><h3>The <code class="literal">"stp"</code> property</h3> -<pre class="programlisting"> "stp" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct</pre> -<p> -Controls whether Spanning Tree Protocol (STP) is enabled for this bridge. -</p> +<a name="NMSettingBridge--stp"></a><h3>The <code class="literal">“stp”</code> property</h3> +<pre class="programlisting"> “stp” <span class="type">gboolean</span></pre> +<p></p> +<p>Flags: Read / Write / Construct</p> <p>Default value: TRUE</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 |