diff options
Diffstat (limited to 'static/freebsd/man4/ng_tee.4 3.html')
| -rw-r--r-- | static/freebsd/man4/ng_tee.4 3.html | 101 |
1 files changed, 101 insertions, 0 deletions
diff --git a/static/freebsd/man4/ng_tee.4 3.html b/static/freebsd/man4/ng_tee.4 3.html new file mode 100644 index 00000000..69fb71a9 --- /dev/null +++ b/static/freebsd/man4/ng_tee.4 3.html @@ -0,0 +1,101 @@ +<table class="head"> + <tr> + <td class="head-ltitle">NG_TEE(4)</td> + <td class="head-vol">Device Drivers Manual</td> + <td class="head-rtitle">NG_TEE(4)</td> + </tr> +</table> +<div class="manual-text"> +<section class="Sh"> +<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> +<p class="Pp"><code class="Nm">ng_tee</code> — <span class="Nd">netgraph + ``tee'' node type</span></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<p class="Pp"><code class="In">#include + <<a class="In">sys/types.h</a>></code> + <br/> + <code class="In">#include + <<a class="In">netgraph/ng_tee.h</a>></code></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<p class="Pp">The <code class="Nm">tee</code> node type has a purpose similar to + the <a class="Xr">tee(1)</a> command. <code class="Nm">Tee</code> nodes are + useful for debugging or “snooping” on a connection between two + netgraph nodes. <code class="Nm">Tee</code> nodes have four hooks, + <code class="Dv">right</code>, <code class="Dv">left</code>, + <code class="Dv">right2left</code>, and <code class="Dv">left2right</code>. + All data received on <code class="Dv">right</code> is sent unmodified to + <a class="permalink" href="#both"><i class="Em" id="both">both</i></a> hooks + <code class="Dv">left</code> and <code class="Dv">right2left</code>. + Similarly, all data received on <code class="Dv">left</code> is sent + unmodified to both <code class="Dv">right</code> and + <code class="Dv">left2right</code>.</p> +<p class="Pp">Packets may also be received on <code class="Dv">right2left</code> + and <code class="Dv">left2right</code>; if so, they are forwarded unchanged + out hooks <code class="Dv">right</code> and <code class="Dv">left</code>, + respectively.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HOOKS"><a class="permalink" href="#HOOKS">HOOKS</a></h1> +<p class="Pp">This node type supports the following hooks:</p> +<dl class="Bl-tag"> + <dt id="right"><var class="Va">right</var></dt> + <dd>The connection to the node on the right.</dd> + <dt id="left"><var class="Va">left</var></dt> + <dd>The connection to the node on the left.</dd> + <dt id="right2left"><var class="Va">right2left</var></dt> + <dd>Tap for right to left traffic.</dd> + <dt id="left2right"><var class="Va">left2right</var></dt> + <dd>Tap for left to right traffic.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="CONTROL_MESSAGES"><a class="permalink" href="#CONTROL_MESSAGES">CONTROL + MESSAGES</a></h1> +<p class="Pp">This node type supports the generic control messages, plus the + following.</p> +<dl class="Bl-tag"> + <dt id="NGM_TEE_GET_STATS"><a class="permalink" href="#NGM_TEE_GET_STATS"><code class="Dv">NGM_TEE_GET_STATS</code></a> + (<code class="Ic">getstats</code>)</dt> + <dd>Get statistics, returned as a <code class="Dv">struct + ng_tee_stats</code>.</dd> + <dt id="NGM_TEE_CLR_STATS"><a class="permalink" href="#NGM_TEE_CLR_STATS"><code class="Dv">NGM_TEE_CLR_STATS</code></a> + (<code class="Ic">clrstats</code>)</dt> + <dd>Clear statistics.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="SHUTDOWN"><a class="permalink" href="#SHUTDOWN">SHUTDOWN</a></h1> +<p class="Pp">This node shuts down upon receipt of an + <code class="Dv">NGM_SHUTDOWN</code> control message, or when all hooks have + been disconnected. If both <code class="Dv">right</code> and + <code class="Dv">left</code> hooks are present, node removes itself from the + chain gently, connecting <code class="Dv">right</code> and + <code class="Dv">left</code> together.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<p class="Pp"><a class="Xr">tee(1)</a>, <a class="Xr">netgraph(4)</a>, + <a class="Xr">ngctl(8)</a></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> +<p class="Pp">The <code class="Nm">ng_tee</code> node type was implemented in + <span class="Ux">FreeBSD 4.0</span>.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> +<p class="Pp"><span class="An">Julian Elischer</span> + <<a class="Mt" href="mailto:julian@FreeBSD.org">julian@FreeBSD.org</a>></p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">May 28, 2004</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |