summary refs log tree commit diff
path: root/docs/libnm/html/NMDeviceMacsec.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/libnm/html/NMDeviceMacsec.html')
-rw-r--r--docs/libnm/html/NMDeviceMacsec.html236
1 files changed, 235 insertions, 1 deletions
diff --git a/docs/libnm/html/NMDeviceMacsec.html b/docs/libnm/html/NMDeviceMacsec.html
index b5bc353a..a310cda5 100644
--- a/docs/libnm/html/NMDeviceMacsec.html
+++ b/docs/libnm/html/NMDeviceMacsec.html
@@ -15,7 +15,9 @@
 <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="#NMDeviceMacsec.description" class="shortcut">Description</a></span>
+                  <a href="#NMDeviceMacsec.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
+                  <a href="#NMDeviceMacsec.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
+                  <a href="#NMDeviceMacsec.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="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
@@ -154,6 +156,85 @@
 </table></div>
 </div>
 <div class="refsect1">
+<a name="NMDeviceMacsec.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-Basic-Types.html#guint64"><span class="type">guint64</span></a></td>
+<td class="property_name"><a class="link" href="NMDeviceMacsec.html#NMDeviceMacsec--cipher-suite" title="The “cipher-suite” property">cipher-suite</a></td>
+<td class="property_flags">Read</td>
+</tr>
+<tr>
+<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a></td>
+<td class="property_name"><a class="link" href="NMDeviceMacsec.html#NMDeviceMacsec--encoding-sa" title="The “encoding-sa” property">encoding-sa</a></td>
+<td class="property_flags">Read</td>
+</tr>
+<tr>
+<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
+<td class="property_name"><a class="link" href="NMDeviceMacsec.html#NMDeviceMacsec--encrypt" title="The “encrypt” property">encrypt</a></td>
+<td class="property_flags">Read</td>
+</tr>
+<tr>
+<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
+<td class="property_name"><a class="link" href="NMDeviceMacsec.html#NMDeviceMacsec--es" title="The “es” property">es</a></td>
+<td class="property_flags">Read</td>
+</tr>
+<tr>
+<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a></td>
+<td class="property_name"><a class="link" href="NMDeviceMacsec.html#NMDeviceMacsec--icv-length" title="The “icv-length” property">icv-length</a></td>
+<td class="property_flags">Read</td>
+</tr>
+<tr>
+<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
+<td class="property_name"><a class="link" href="NMDeviceMacsec.html#NMDeviceMacsec--include-sci" title="The “include-sci” property">include-sci</a></td>
+<td class="property_flags">Read</td>
+</tr>
+<tr>
+<td class="property_type">
+<a class="link" href="NMDevice.html" title="NMDevice"><span class="type">NMDevice</span></a> *</td>
+<td class="property_name"><a class="link" href="NMDeviceMacsec.html#NMDeviceMacsec--parent" title="The “parent” property">parent</a></td>
+<td class="property_flags">Read</td>
+</tr>
+<tr>
+<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
+<td class="property_name"><a class="link" href="NMDeviceMacsec.html#NMDeviceMacsec--protect" title="The “protect” property">protect</a></td>
+<td class="property_flags">Read</td>
+</tr>
+<tr>
+<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
+<td class="property_name"><a class="link" href="NMDeviceMacsec.html#NMDeviceMacsec--replay-protect" title="The “replay-protect” property">replay-protect</a></td>
+<td class="property_flags">Read</td>
+</tr>
+<tr>
+<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
+<td class="property_name"><a class="link" href="NMDeviceMacsec.html#NMDeviceMacsec--scb" title="The “scb” property">scb</a></td>
+<td class="property_flags">Read</td>
+</tr>
+<tr>
+<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></td>
+<td class="property_name"><a class="link" href="NMDeviceMacsec.html#NMDeviceMacsec--sci" title="The “sci” property">sci</a></td>
+<td class="property_flags">Read</td>
+</tr>
+<tr>
+<td class="property_type">
+<span class="type">char</span> *</td>
+<td class="property_name"><a class="link" href="NMDeviceMacsec.html#NMDeviceMacsec--validation" title="The “validation” property">validation</a></td>
+<td class="property_flags">Read</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="NMDeviceMacsec.html#NMDeviceMacsec--window" title="The “window” property">window</a></td>
+<td class="property_flags">Read</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
 <a name="NMDeviceMacsec.other"></a><h2>Types and Values</h2>
 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
@@ -217,10 +298,22 @@
 <td class="define_keyword">#define</td>
 <td class="function_name"><a class="link" href="NMDeviceMacsec.html#NM-DEVICE-MACSEC-REPLAY-PROTECT:CAPS" title="NM_DEVICE_MACSEC_REPLAY_PROTECT">NM_DEVICE_MACSEC_REPLAY_PROTECT</a></td>
 </tr>
+<tr>
+<td class="datatype_keyword"> </td>
+<td class="function_name"><a class="link" href="NMDeviceMacsec.html#NMDeviceMacsec-struct" title="NMDeviceMacsec">NMDeviceMacsec</a></td>
+</tr>
 </tbody>
 </table></div>
 </div>
 <div class="refsect1">
+<a name="NMDeviceMacsec.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="screen">    <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="NMObject.html" title="NMObject">NMObject</a>
+        <span class="lineart">╰──</span> <a class="link" href="NMDevice.html" title="NMDevice">NMDevice</a>
+            <span class="lineart">╰──</span> NMDeviceMacsec
+</pre>
+</div>
+<div class="refsect1">
 <a name="NMDeviceMacsec.description"></a><h2>Description</h2>
 </div>
 <div class="refsect1">
@@ -673,6 +766,147 @@ nm_device_macsec_get_replay_protect (<em class="parameter"><code><a class="link"
 <pre class="programlisting">#define NM_DEVICE_MACSEC_REPLAY_PROTECT "replay-protect"
 </pre>
 </div>
+<hr>
+<div class="refsect2">
+<a name="NMDeviceMacsec-struct"></a><h3>NMDeviceMacsec</h3>
+<pre class="programlisting">typedef struct _NMDeviceMacsec NMDeviceMacsec;</pre>
+</div>
+</div>
+<div class="refsect1">
+<a name="NMDeviceMacsec.property-details"></a><h2>Property Details</h2>
+<div class="refsect2">
+<a name="NMDeviceMacsec--cipher-suite"></a><h3>The <code class="literal">“cipher-suite”</code> property</h3>
+<pre class="programlisting">  “cipher-suite”             <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre>
+<p>The set of cryptographic algorithms in use.</p>
+<p>Owner: NMDeviceMacsec</p>
+<p>Flags: Read</p>
+<p>Default value: 0</p>
+<p class="since">Since: 1.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="NMDeviceMacsec--encoding-sa"></a><h3>The <code class="literal">“encoding-sa”</code> property</h3>
+<pre class="programlisting">  “encoding-sa”              <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a></pre>
+<p>The value of the Association Number (0..3) for the Security
+Association in use.</p>
+<p>Owner: NMDeviceMacsec</p>
+<p>Flags: Read</p>
+<p>Default value: 0</p>
+<p class="since">Since: 1.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="NMDeviceMacsec--encrypt"></a><h3>The <code class="literal">“encrypt”</code> property</h3>
+<pre class="programlisting">  “encrypt”                  <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
+<p>Whether encryption of transmitted frames is enabled.</p>
+<p>Owner: NMDeviceMacsec</p>
+<p>Flags: Read</p>
+<p>Default value: FALSE</p>
+<p class="since">Since: 1.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="NMDeviceMacsec--es"></a><h3>The <code class="literal">“es”</code> property</h3>
+<pre class="programlisting">  “es”                       <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
+<p>Whether the ES (End station) bit is enabled in SecTAG for
+transmitted frames.</p>
+<p>Owner: NMDeviceMacsec</p>
+<p>Flags: Read</p>
+<p>Default value: FALSE</p>
+<p class="since">Since: 1.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="NMDeviceMacsec--icv-length"></a><h3>The <code class="literal">“icv-length”</code> property</h3>
+<pre class="programlisting">  “icv-length”               <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a></pre>
+<p>The length of ICV (Integrity Check Value).</p>
+<p>Owner: NMDeviceMacsec</p>
+<p>Flags: Read</p>
+<p>Default value: 0</p>
+<p class="since">Since: 1.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="NMDeviceMacsec--include-sci"></a><h3>The <code class="literal">“include-sci”</code> property</h3>
+<pre class="programlisting">  “include-sci”              <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
+<p>Whether the SCI is always included in SecTAG for transmitted
+frames.</p>
+<p>Owner: NMDeviceMacsec</p>
+<p>Flags: Read</p>
+<p>Default value: FALSE</p>
+<p class="since">Since: 1.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="NMDeviceMacsec--parent"></a><h3>The <code class="literal">“parent”</code> property</h3>
+<pre class="programlisting">  “parent”                   <a class="link" href="NMDevice.html" title="NMDevice"><span class="type">NMDevice</span></a> *</pre>
+<p>The devices's parent device.</p>
+<p>Owner: NMDeviceMacsec</p>
+<p>Flags: Read</p>
+<p class="since">Since: 1.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="NMDeviceMacsec--protect"></a><h3>The <code class="literal">“protect”</code> property</h3>
+<pre class="programlisting">  “protect”                  <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
+<p>Whether protection of transmitted frames is enabled.</p>
+<p>Owner: NMDeviceMacsec</p>
+<p>Flags: Read</p>
+<p>Default value: FALSE</p>
+<p class="since">Since: 1.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="NMDeviceMacsec--replay-protect"></a><h3>The <code class="literal">“replay-protect”</code> property</h3>
+<pre class="programlisting">  “replay-protect”           <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
+<p>Whether replay protection is enabled.</p>
+<p>Owner: NMDeviceMacsec</p>
+<p>Flags: Read</p>
+<p>Default value: FALSE</p>
+<p class="since">Since: 1.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="NMDeviceMacsec--scb"></a><h3>The <code class="literal">“scb”</code> property</h3>
+<pre class="programlisting">  “scb”                      <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
+<p>Whether the SCB (Single Copy Broadcast) bit is enabled in
+SecTAG for transmitted frames.</p>
+<p>Owner: NMDeviceMacsec</p>
+<p>Flags: Read</p>
+<p>Default value: FALSE</p>
+<p class="since">Since: 1.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="NMDeviceMacsec--sci"></a><h3>The <code class="literal">“sci”</code> property</h3>
+<pre class="programlisting">  “sci”                      <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre>
+<p>The Secure Channel Identifier in use.</p>
+<p>Owner: NMDeviceMacsec</p>
+<p>Flags: Read</p>
+<p>Default value: 0</p>
+<p class="since">Since: 1.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="NMDeviceMacsec--validation"></a><h3>The <code class="literal">“validation”</code> property</h3>
+<pre class="programlisting">  “validation”               <span class="type">char</span> *</pre>
+<p>The validation mode for incoming packets (strict, check,
+disabled).</p>
+<p>Owner: NMDeviceMacsec</p>
+<p>Flags: Read</p>
+<p>Default value: NULL</p>
+<p class="since">Since: 1.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="NMDeviceMacsec--window"></a><h3>The <code class="literal">“window”</code> property</h3>
+<pre class="programlisting">  “window”                   <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
+<p>The size of the replay window.</p>
+<p>Owner: NMDeviceMacsec</p>
+<p>Flags: Read</p>
+<p>Default value: 0</p>
+<p class="since">Since: 1.6</p>
+</div>
 </div>
 </div>
 <div class="footer">