diff options
Diffstat (limited to 'docs/libnm/html/NMSettingVlan.html')
| -rw-r--r-- | docs/libnm/html/NMSettingVlan.html | 151 |
1 files changed, 18 insertions, 133 deletions
diff --git a/docs/libnm/html/NMSettingVlan.html b/docs/libnm/html/NMSettingVlan.html index 3f32377a..5486cd0d 100644 --- a/docs/libnm/html/NMSettingVlan.html +++ b/docs/libnm/html/NMSettingVlan.html @@ -16,8 +16,7 @@ <td width="100%" align="left" class="shortcuts"> <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> <a href="#NMSettingVlan.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#NMSettingVlan.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#NMSettingVlan.properties" class="shortcut">Properties</a></span> + <a href="#NMSettingVlan.object-hierarchy" class="shortcut">Object Hierarchy</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> @@ -140,44 +139,6 @@ </table></div> </div> <div class="refsect1"> -<a name="NMSettingVlan.properties"></a><h2>Properties</h2> -<div class="informaltable"><table class="informaltable" 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"><a href="https://developer.gnome.org/glib/unstable/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></td> -<td class="property_name"><a class="link" href="NMSettingVlan.html#NMSettingVlan--egress-priority-map" title="The “egress-priority-map” property">egress-priority-map</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><a class="link" href="NMSettingVlan.html#NMVlanFlags" title="enum NMVlanFlags"><span class="type">NMVlanFlags</span></a></td> -<td class="property_name"><a class="link" href="NMSettingVlan.html#NMSettingVlan--flags" title="The “flags” property">flags</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> -<td class="property_name"><a class="link" href="NMSettingVlan.html#NMSettingVlan--id" title="The “id” property">id</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></td> -<td class="property_name"><a class="link" href="NMSettingVlan.html#NMSettingVlan--ingress-priority-map" title="The “ingress-priority-map” property">ingress-priority-map</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">char</span> *</td> -<td class="property_name"><a class="link" href="NMSettingVlan.html#NMSettingVlan--parent" title="The “parent” property">parent</a></td> -<td class="property_flags">Read / Write</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> <a name="NMSettingVlan.other"></a><h2>Types and Values</h2> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> @@ -210,10 +171,6 @@ <td class="function_name"><a class="link" href="NMSettingVlan.html#NM-SETTING-VLAN-EGRESS-PRIORITY-MAP:CAPS" title="NM_SETTING_VLAN_EGRESS_PRIORITY_MAP">NM_SETTING_VLAN_EGRESS_PRIORITY_MAP</a></td> </tr> <tr> -<td class="datatype_keyword"> </td> -<td class="function_name"><a class="link" href="NMSettingVlan.html#NMSettingVlan-struct" title="NMSettingVlan">NMSettingVlan</a></td> -</tr> -<tr> <td class="datatype_keyword">enum</td> <td class="function_name"><a class="link" href="NMSettingVlan.html#NMVlanPriorityMap" title="enum NMVlanPriorityMap">NMVlanPriorityMap</a></td> </tr> @@ -234,9 +191,6 @@ <span class="lineart">╰──</span> NMVlanPriorityMap <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GFlags</a> <span class="lineart">╰──</span> NMVlanFlags - <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> - <span class="lineart">╰──</span> <a class="link" href="NMSetting.html" title="NMSetting">NMSetting</a> - <span class="lineart">╰──</span> NMSettingVlan </pre> </div> <div class="refsect1"> @@ -279,7 +233,7 @@ nm_setting_vlan_get_parent (<em class="parameter"><code><a class="link" href="NM </div> <div class="refsect3"> <a name="nm-setting-vlan-get-parent.returns"></a><h4>Returns</h4> -<p> the <a class="link" href="NMSettingVlan.html#NMSettingVlan--parent" title="The “parent” property"><span class="type">“parent”</span></a> property of the setting</p> +<p> the <a href="NMSettingVlan.html#NMSettingVlan--parent"><span class="type">“parent”</span></a> property of the setting</p> </div> </div> <hr> @@ -304,7 +258,7 @@ nm_setting_vlan_get_id (<em class="parameter"><code><a class="link" href="NMSett </div> <div class="refsect3"> <a name="nm-setting-vlan-get-id.returns"></a><h4>Returns</h4> -<p> the <a class="link" href="NMSettingVlan.html#NMSettingVlan--id" title="The “id” property"><span class="type">“id”</span></a> property of the setting</p> +<p> the <a href="NMSettingVlan.html#NMSettingVlan--id"><span class="type">“id”</span></a> property of the setting</p> </div> </div> <hr> @@ -329,7 +283,7 @@ nm_setting_vlan_get_flags (<em class="parameter"><code><a class="link" href="NMS </div> <div class="refsect3"> <a name="nm-setting-vlan-get-flags.returns"></a><h4>Returns</h4> -<p> the <a class="link" href="NMSettingVlan.html#NMSettingVlan--flags" title="The “flags” property"><span class="type">“flags”</span></a> property of the setting</p> +<p> the <a href="NMSettingVlan.html#NMSettingVlan--flags"><span class="type">“flags”</span></a> property of the setting</p> </div> </div> <hr> @@ -339,7 +293,7 @@ nm_setting_vlan_get_flags (<em class="parameter"><code><a class="link" href="NMS nm_setting_vlan_get_num_priorities (<em class="parameter"><code><a class="link" href="NMSettingVlan.html" title="NMSettingVlan"><span class="type">NMSettingVlan</span></a> *setting</code></em>, <em class="parameter"><code><a class="link" href="NMSettingVlan.html#NMVlanPriorityMap" title="enum NMVlanPriorityMap"><span class="type">NMVlanPriorityMap</span></a> map</code></em>);</pre> <p>Returns the number of entries in the -<a class="link" href="NMSettingVlan.html#NMSettingVlan--ingress-priority-map" title="The “ingress-priority-map” property"><span class="type">“ingress_priority_map”</span></a> or <a class="link" href="NMSettingVlan.html#NMSettingVlan--egress-priority-map" title="The “egress-priority-map” property"><span class="type">“egress_priority_map”</span></a> +<a href="NMSettingVlan.html#NMSettingVlan--ingress-priority-map"><span class="type">“ingress_priority_map”</span></a> or <a href="NMSettingVlan.html#NMSettingVlan--egress-priority-map"><span class="type">“egress_priority_map”</span></a> properties of this setting.</p> <div class="refsect3"> <a name="nm-setting-vlan-get-num-priorities.parameters"></a><h4>Parameters</h4> @@ -377,8 +331,8 @@ nm_setting_vlan_get_priority (<em class="parameter"><code><a class="link" href=" <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> idx</code></em>, <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> *out_from</code></em>, <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> *out_to</code></em>);</pre> -<p>Retrieve one of the entries of the <a class="link" href="NMSettingVlan.html#NMSettingVlan--ingress-priority-map" title="The “ingress-priority-map” property"><span class="type">“ingress_priority_map”</span></a> -or <a class="link" href="NMSettingVlan.html#NMSettingVlan--egress-priority-map" title="The “egress-priority-map” property"><span class="type">“egress_priority_map”</span></a> properties of this setting.</p> +<p>Retrieve one of the entries of the <a href="NMSettingVlan.html#NMSettingVlan--ingress-priority-map"><span class="type">“ingress_priority_map”</span></a> +or <a href="NMSettingVlan.html#NMSettingVlan--egress-priority-map"><span class="type">“egress_priority_map”</span></a> properties of this setting.</p> <div class="refsect3"> <a name="nm-setting-vlan-get-priority.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> @@ -430,8 +384,8 @@ nm_setting_vlan_add_priority (<em class="parameter"><code><a class="link" href=" <em class="parameter"><code><a class="link" href="NMSettingVlan.html#NMVlanPriorityMap" title="enum NMVlanPriorityMap"><span class="type">NMVlanPriorityMap</span></a> map</code></em>, <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> from</code></em>, <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> to</code></em>);</pre> -<p>Adds a priority mapping to the <a class="link" href="NMSettingVlan.html#NMSettingVlan--ingress-priority-map" title="The “ingress-priority-map” property"><span class="type">“ingress_priority_map”</span></a> or -<a class="link" href="NMSettingVlan.html#NMSettingVlan--egress-priority-map" title="The “egress-priority-map” property"><span class="type">“egress_priority_map”</span></a> properties of the setting. If <em class="parameter"><code>from</code></em> +<p>Adds a priority mapping to the <a href="NMSettingVlan.html#NMSettingVlan--ingress-priority-map"><span class="type">“ingress_priority_map”</span></a> or +<a href="NMSettingVlan.html#NMSettingVlan--egress-priority-map"><span class="type">“egress_priority_map”</span></a> properties of the setting. If <em class="parameter"><code>from</code></em> is already in the given priority map, this function will overwrite the existing entry with the new <em class="parameter"><code>to</code></em> @@ -494,7 +448,7 @@ nm_setting_vlan_remove_priority (<em class="parameter"><code><a class="link" hre <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> idx</code></em>);</pre> <p>Removes the priority map at index <em class="parameter"><code>idx</code></em> from the -<a class="link" href="NMSettingVlan.html#NMSettingVlan--ingress-priority-map" title="The “ingress-priority-map” property"><span class="type">“ingress_priority_map”</span></a> or <a class="link" href="NMSettingVlan.html#NMSettingVlan--egress-priority-map" title="The “egress-priority-map” property"><span class="type">“egress_priority_map”</span></a> +<a href="NMSettingVlan.html#NMSettingVlan--ingress-priority-map"><span class="type">“ingress_priority_map”</span></a> or <a href="NMSettingVlan.html#NMSettingVlan--egress-priority-map"><span class="type">“egress_priority_map”</span></a> properties.</p> <div class="refsect3"> <a name="nm-setting-vlan-remove-priority.parameters"></a><h4>Parameters</h4> @@ -535,8 +489,8 @@ nm_setting_vlan_remove_priority_by_value <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> to</code></em>);</pre> <p>Removes the priority map <em class="parameter"><code>form</code></em> :<em class="parameter"><code>to</code></em> - from the <a class="link" href="NMSettingVlan.html#NMSettingVlan--ingress-priority-map" title="The “ingress-priority-map” property"><span class="type">“ingress_priority_map”</span></a> -or <a class="link" href="NMSettingVlan.html#NMSettingVlan--egress-priority-map" title="The “egress-priority-map” property"><span class="type">“egress_priority_map”</span></a> (according to <em class="parameter"><code>map</code></em> + from the <a href="NMSettingVlan.html#NMSettingVlan--ingress-priority-map"><span class="type">“ingress_priority_map”</span></a> +or <a href="NMSettingVlan.html#NMSettingVlan--egress-priority-map"><span class="type">“egress_priority_map”</span></a> (according to <em class="parameter"><code>map</code></em> argument) properties.</p> <div class="refsect3"> @@ -587,8 +541,8 @@ nm_setting_vlan_remove_priority_str_by_value <em class="parameter"><code><a class="link" href="NMSettingVlan.html#NMVlanPriorityMap" title="enum NMVlanPriorityMap"><span class="type">NMVlanPriorityMap</span></a> map</code></em>, <em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre> <p>Removes the priority map <em class="parameter"><code>str</code></em> - from the <a class="link" href="NMSettingVlan.html#NMSettingVlan--ingress-priority-map" title="The “ingress-priority-map” property"><span class="type">“ingress_priority_map”</span></a> -or <a class="link" href="NMSettingVlan.html#NMSettingVlan--egress-priority-map" title="The “egress-priority-map” property"><span class="type">“egress_priority_map”</span></a> (according to <em class="parameter"><code>map</code></em> + from the <a href="NMSettingVlan.html#NMSettingVlan--ingress-priority-map"><span class="type">“ingress_priority_map”</span></a> +or <a href="NMSettingVlan.html#NMSettingVlan--egress-priority-map"><span class="type">“egress_priority_map”</span></a> (according to <em class="parameter"><code>map</code></em> argument) properties.</p> <div class="refsect3"> @@ -629,8 +583,8 @@ properties.</p> <pre class="programlisting"><span class="returnvalue">void</span> nm_setting_vlan_clear_priorities (<em class="parameter"><code><a class="link" href="NMSettingVlan.html" title="NMSettingVlan"><span class="type">NMSettingVlan</span></a> *setting</code></em>, <em class="parameter"><code><a class="link" href="NMSettingVlan.html#NMVlanPriorityMap" title="enum NMVlanPriorityMap"><span class="type">NMVlanPriorityMap</span></a> map</code></em>);</pre> -<p>Clear all the entries from <a class="link" href="NMSettingVlan.html#NMSettingVlan--ingress-priority-map" title="The “ingress-priority-map” property"><span class="type">“ingress_priority_map”</span></a> or -<a class="link" href="NMSettingVlan.html#NMSettingVlan--egress-priority-map" title="The “egress-priority-map” property"><span class="type">“egress_priority_map”</span></a> properties.</p> +<p>Clear all the entries from <a href="NMSettingVlan.html#NMSettingVlan--ingress-priority-map"><span class="type">“ingress_priority_map”</span></a> or +<a href="NMSettingVlan.html#NMSettingVlan--egress-priority-map"><span class="type">“egress_priority_map”</span></a> properties.</p> <div class="refsect3"> <a name="nm-setting-vlan-clear-priorities.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> @@ -661,8 +615,8 @@ nm_setting_vlan_clear_priorities (<em class="parameter"><code><a class="link" hr nm_setting_vlan_add_priority_str (<em class="parameter"><code><a class="link" href="NMSettingVlan.html" title="NMSettingVlan"><span class="type">NMSettingVlan</span></a> *setting</code></em>, <em class="parameter"><code><a class="link" href="NMSettingVlan.html#NMVlanPriorityMap" title="enum NMVlanPriorityMap"><span class="type">NMVlanPriorityMap</span></a> map</code></em>, <em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre> -<p>Adds a priority map entry into either the <a class="link" href="NMSettingVlan.html#NMSettingVlan--ingress-priority-map" title="The “ingress-priority-map” property"><span class="type">“ingress_priority_map”</span></a> -or the <a class="link" href="NMSettingVlan.html#NMSettingVlan--egress-priority-map" title="The “egress-priority-map” property"><span class="type">“egress_priority_map”</span></a> properties. The priority map maps +<p>Adds a priority map entry into either the <a href="NMSettingVlan.html#NMSettingVlan--ingress-priority-map"><span class="type">“ingress_priority_map”</span></a> +or the <a href="NMSettingVlan.html#NMSettingVlan--egress-priority-map"><span class="type">“egress_priority_map”</span></a> properties. The priority map maps the Linux SKB priorities to 802.1p priorities.</p> <div class="refsect3"> <a name="nm-setting-vlan-add-priority-str.parameters"></a><h4>Parameters</h4> @@ -738,12 +692,6 @@ is not a valid mapping.</p> </div> <hr> <div class="refsect2"> -<a name="NMSettingVlan-struct"></a><h3>NMSettingVlan</h3> -<pre class="programlisting">typedef struct _NMSettingVlan NMSettingVlan;</pre> -<p>VLAN Settings</p> -</div> -<hr> -<div class="refsect2"> <a name="NMVlanPriorityMap"></a><h3>enum NMVlanPriorityMap</h3> <p>A selector for traffic priority maps; these map Linux SKB priorities to 802.1p priorities used in VLANs.</p> @@ -830,69 +778,6 @@ itself with its switch</p> <pre class="programlisting">#define NM_VLAN_FLAGS_ALL</pre> </div> </div> -<div class="refsect1"> -<a name="NMSettingVlan.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="NMSettingVlan--egress-priority-map"></a><h3>The <code class="literal">“egress-priority-map”</code> property</h3> -<pre class="programlisting"> “egress-priority-map” <a href="https://developer.gnome.org/glib/unstable/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></pre> -<p>For outgoing packets, a list of mappings from Linux SKB priorities to -802.1p priorities. The mapping is given in the format "from:to" where -both "from" and "to" are unsigned integers, ie "7:3".</p> -<p>Owner: NMSettingVlan</p> -<p>Flags: Read / Write</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingVlan--flags"></a><h3>The <code class="literal">“flags”</code> property</h3> -<pre class="programlisting"> “flags” <a class="link" href="NMSettingVlan.html#NMVlanFlags" title="enum NMVlanFlags"><span class="type">NMVlanFlags</span></a></pre> -<p>One or more flags which control the behavior and features of the VLAN -interface. Flags include <a class="link" href="NMSettingVlan.html#NM-VLAN-FLAG-REORDER-HEADERS:CAPS"><code class="literal">NM_VLAN_FLAG_REORDER_HEADERS</code></a> (reordering of -output packet headers), <a class="link" href="NMSettingVlan.html#NM-VLAN-FLAG-GVRP:CAPS"><code class="literal">NM_VLAN_FLAG_GVRP</code></a> (use of the GVRP protocol), -and <a class="link" href="NMSettingVlan.html#NM-VLAN-FLAG-LOOSE-BINDING:CAPS"><code class="literal">NM_VLAN_FLAG_LOOSE_BINDING</code></a> (loose binding of the interface to its -master device's operating state). <a class="link" href="NMSettingVlan.html#NM-VLAN-FLAG-MVRP:CAPS"><code class="literal">NM_VLAN_FLAG_MVRP</code></a> (use of the MVRP -protocol).</p> -<p>The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, -but it used to be 0. To preserve backward compatibility, the default-value -in the D-Bus API continues to be 0 and a missing property on D-Bus -is still considered as 0.</p> -<p>Owner: NMSettingVlan</p> -<p>Flags: Read / Write</p> -<p>Default value: NM_VLAN_FLAG_REORDER_HEADERS</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingVlan--id"></a><h3>The <code class="literal">“id”</code> property</h3> -<pre class="programlisting"> “id” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> -<p>The VLAN identifier that the interface created by this connection should -be assigned. The valid range is from 0 to 4094, without the reserved id 4095.</p> -<p>Owner: NMSettingVlan</p> -<p>Flags: Read / Write</p> -<p>Allowed values: <= 4095</p> -<p>Default value: 0</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingVlan--ingress-priority-map"></a><h3>The <code class="literal">“ingress-priority-map”</code> property</h3> -<pre class="programlisting"> “ingress-priority-map” <a href="https://developer.gnome.org/glib/unstable/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a></pre> -<p>For incoming packets, a list of mappings from 802.1p priorities to Linux -SKB priorities. The mapping is given in the format "from:to" where both -"from" and "to" are unsigned integers, ie "7:3".</p> -<p>Owner: NMSettingVlan</p> -<p>Flags: Read / Write</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingVlan--parent"></a><h3>The <code class="literal">“parent”</code> property</h3> -<pre class="programlisting"> “parent” <span class="type">char</span> *</pre> -<p>If given, specifies the parent interface name or parent connection UUID -from which this VLAN interface should be created. If this property is -not specified, the connection must contain an <a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a> setting -with a <a class="link" href="NMSettingWired.html#NMSettingWired--mac-address" title="The “mac-address” property"><span class="type">“mac-address”</span></a> property.</p> -<p>Owner: NMSettingVlan</p> -<p>Flags: Read / Write</p> -<p>Default value: NULL</p> -</div> -</div> </div> <div class="footer"> <hr>Generated by GTK-Doc V1.33.0</div> |