diff options
Diffstat (limited to 'docs/libnm-util/html/NMSettingVlan.html')
| -rw-r--r-- | docs/libnm-util/html/NMSettingVlan.html | 66 |
1 files changed, 27 insertions, 39 deletions
diff --git a/docs/libnm-util/html/NMSettingVlan.html b/docs/libnm-util/html/NMSettingVlan.html index be791417..35e0e7a9 100644 --- a/docs/libnm-util/html/NMSettingVlan.html +++ b/docs/libnm-util/html/NMSettingVlan.html @@ -2,13 +2,13 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>libnm-util Reference Manual: NMSettingVlan</title> +<title>NMSettingVlan: libnm-util Reference Manual</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.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="NMSettingInfiniband.html" title="NMSettingInfiniband"> <link rel="next" href="NMSettingOlpcMesh.html" title="NMSettingOlpcMesh"> -<meta name="generator" content="GTK-Doc V1.21 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -286,7 +286,6 @@ nm_setting_vlan_error_quark (<em class="parameter"><code><span class="type">void <div class="refsect3"> <a name="id-1.2.20.9.2.5"></a><h4>Returns</h4> <p> the error quark used for <a class="link" href="NMSettingVlan.html" title="NMSettingVlan"><span class="type">NMSettingVlan</span></a> errors.</p> -<p></p> </div> </div> <hr> @@ -324,7 +323,6 @@ nm_setting_vlan_get_interface_name (<em class="parameter"><code><a class="link" <div class="refsect3"> <a name="id-1.2.20.9.4.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingVlan.html#NMSettingVlan--interface-name" title="The “interface-name” property"><span class="type">“interface_name”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -350,7 +348,6 @@ nm_setting_vlan_get_parent (<em class="parameter"><code><a class="link" href="NM <div class="refsect3"> <a name="id-1.2.20.9.5.5"></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></p> </div> </div> <hr> @@ -376,7 +373,6 @@ nm_setting_vlan_get_id (<em class="parameter"><code><a class="link" href="NMSett <div class="refsect3"> <a name="id-1.2.20.9.6.5"></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></p> </div> </div> <hr> @@ -402,7 +398,6 @@ nm_setting_vlan_get_flags (<em class="parameter"><code><a class="link" href="NMS <div class="refsect3"> <a name="id-1.2.20.9.7.5"></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></p> </div> </div> <hr> @@ -439,7 +434,6 @@ properties of this setting.</p> <div class="refsect3"> <a name="id-1.2.20.9.8.6"></a><h4>Returns</h4> <p> return the number of ingress/egress priority entries, -1 if error</p> -<p></p> </div> </div> <hr> @@ -493,7 +487,6 @@ or <a class="link" href="NMSettingVlan.html#NMSettingVlan--egress-priority-map" <div class="refsect3"> <a name="id-1.2.20.9.9.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if a priority map was returned, <code class="literal">FALSE</code> if error</p> -<p></p> </div> </div> <hr> @@ -558,7 +551,6 @@ to</p></td> <a name="id-1.2.20.9.10.8"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the new priority mapping was successfully added to the list, <code class="literal">FALSE</code> if error</p> -<p></p> </div> </div> <hr> @@ -652,9 +644,8 @@ to</p></td> <div class="refsect3"> <a name="id-1.2.20.9.12.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the priority mapping was found and removed; <code class="literal">FALSE</code> if it was not.</p> -<p></p> </div> -<p class="since">Since 0.9.10</p> +<p class="since">Since: 0.9.10</p> </div> <hr> <div class="refsect2"> @@ -699,9 +690,8 @@ properties.</p> <div class="refsect3"> <a name="id-1.2.20.9.13.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the priority mapping was found and removed; <code class="literal">FALSE</code> if it was not.</p> -<p></p> </div> -<p class="since">Since 0.9.10</p> +<p class="since">Since: 0.9.10</p> </div> <hr> <div class="refsect2"> @@ -775,7 +765,6 @@ the Linux SKB priorities to 802.1p priorities.</p> <a name="id-1.2.20.9.15.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the entry was successfully added to the list, or it overwrote the old value, <code class="literal">FALSE</code> if error</p> -<p></p> </div> </div> </div> @@ -785,8 +774,6 @@ overwrote the old value, <code class="literal">FALSE</code> if error</p> <a name="NM-SETTING-VLAN-SETTING-NAME:CAPS"></a><h3>NM_SETTING_VLAN_SETTING_NAME</h3> <pre class="programlisting">#define NM_SETTING_VLAN_SETTING_NAME "vlan" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> @@ -839,56 +826,42 @@ overwrote the old value, <code class="literal">FALSE</code> if error</p> <a name="NM-SETTING-VLAN-ERROR:CAPS"></a><h3>NM_SETTING_VLAN_ERROR</h3> <pre class="programlisting">#define NM_SETTING_VLAN_ERROR nm_setting_vlan_error_quark () </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-VLAN-INTERFACE-NAME:CAPS"></a><h3>NM_SETTING_VLAN_INTERFACE_NAME</h3> <pre class="programlisting">#define NM_SETTING_VLAN_INTERFACE_NAME "interface-name" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-VLAN-PARENT:CAPS"></a><h3>NM_SETTING_VLAN_PARENT</h3> <pre class="programlisting">#define NM_SETTING_VLAN_PARENT "parent" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-VLAN-ID:CAPS"></a><h3>NM_SETTING_VLAN_ID</h3> <pre class="programlisting">#define NM_SETTING_VLAN_ID "id" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-VLAN-FLAGS:CAPS"></a><h3>NM_SETTING_VLAN_FLAGS</h3> <pre class="programlisting">#define NM_SETTING_VLAN_FLAGS "flags" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-VLAN-INGRESS-PRIORITY-MAP:CAPS"></a><h3>NM_SETTING_VLAN_INGRESS_PRIORITY_MAP</h3> <pre class="programlisting">#define NM_SETTING_VLAN_INGRESS_PRIORITY_MAP "ingress-priority-map" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-VLAN-EGRESS-PRIORITY-MAP:CAPS"></a><h3>NM_SETTING_VLAN_EGRESS_PRIORITY_MAP</h3> <pre class="programlisting">#define NM_SETTING_VLAN_EGRESS_PRIORITY_MAP "egress-priority-map" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> @@ -970,14 +943,20 @@ to 802.1p priorities used in VLANs.</p> <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” <span class="type">GSList_gchararray_</span> *</pre> -<p></p> +<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>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” <span class="type">guint</span></pre> -<p></p> +<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).</p> <p>Flags: Read / Write / Construct</p> <p>Default value: 0</p> </div> @@ -985,7 +964,8 @@ to 802.1p priorities used in VLANs.</p> <div class="refsect2"> <a name="NMSettingVlan--id"></a><h3>The <code class="literal">“id”</code> property</h3> <pre class="programlisting"> “id” <span class="type">guint</span></pre> -<p></p> +<p>The VLAN identifier that the interface created by this connection should +be assigned.</p> <p>Flags: Read / Write / Construct</p> <p>Allowed values: <= 4095</p> <p>Default value: 0</p> @@ -994,14 +974,20 @@ to 802.1p priorities used in VLANs.</p> <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” <span class="type">GSList_gchararray_</span> *</pre> -<p></p> +<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>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSettingVlan--interface-name"></a><h3>The <code class="literal">“interface-name”</code> property</h3> <pre class="programlisting"> “interface-name” <span class="type">gchar</span> *</pre> -<p></p> +<p>If given, specifies the kernel name of the VLAN interface. If not given, +a default name will be constructed from the interface described by the +parent interface and the <a class="link" href="NMSettingVlan.html#NMSettingVlan--id" title="The “id” property"><span class="type">“id”</span></a> property, eg "eth2.1". The +parent interface may be given by the <a class="link" href="NMSettingVlan.html#NMSettingVlan--parent" title="The “parent” property"><span class="type">“parent”</span></a> property or by +the <a class="link" href="NMSettingWired.html#NMSettingWired--mac-address" title="The “mac-address” property"><span class="type">“mac-address”</span></a> property of an <a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a> setting.</p> <p>Flags: Read / Write / Construct</p> <p>Default value: NULL</p> </div> @@ -1009,14 +995,16 @@ to 802.1p priorities used in VLANs.</p> <div class="refsect2"> <a name="NMSettingVlan--parent"></a><h3>The <code class="literal">“parent”</code> property</h3> <pre class="programlisting"> “parent” <span class="type">gchar</span> *</pre> -<p></p> +<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>Flags: Read / Write / Construct</p> <p>Default value: NULL</p> </div> </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.21</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html> \ No newline at end of file |