share/man/man4/ng_tee.4

   1 .\" Copyright (c) 1996-1999 Whistle Communications, Inc.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Subject to the following obligations and disclaimer of warranty, use and
   5 .\" redistribution of this software, in source or object code forms, with or
   6 .\" without modifications are expressly permitted by Whistle Communications;
   7 .\" provided, however, that:
   8 .\" 1. Any and all reproductions of the source or object code must include the
   9 .\"    copyright notice above and the following disclaimer of warranties; and
  10 .\" 2. No rights are granted, in any manner or form, to use Whistle
  11 .\"    Communications, Inc. trademarks, including the mark "WHISTLE
  12 .\"    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
  13 .\"    such appears in the above copyright notice or in the software.
  14 .\"
  15 .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
  16 .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
  17 .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
  18 .\" INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
  19 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
  20 .\" WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
  21 .\" REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
  22 .\" SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
  23 .\" IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
  24 .\" RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
  25 .\" WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
  26 .\" PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
  27 .\" SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
  28 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  30 .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
  31 .\" OF SUCH DAMAGE.
  32 .\"
  33 .\" Author: Archie Cobbs <archie@FreeBSD.org>
  34 .\"
  35 .\" $FreeBSD: src/share/man/man4/ng_tee.4,v 1.12.2.1 2001/12/21 09:00:51 ru Exp $
  36 .\" $Whistle: ng_tee.8,v 1.4 1999/01/25 23:46:27 archie Exp $
  37 .\"
  38 .Dd January 19, 1999
  39 .Dt NG_TEE 4
  40 .Os
  41 .Sh NAME
  42 .Nm ng_tee
  43 .Nd netgraph ``tee'' node type
  44 .Sh SYNOPSIS
  45 .In netgraph/tee/ng_tee.h
  46 .Sh DESCRIPTION
  47 The
  48 .Nm tee
  49 node type has a purpose similar to the
  50 .Xr tee 1
  51 command.
  52 .Nm Tee
  53 nodes are useful for debugging or
  54 .Dq snooping
  55 on a connection
  56 between two netgraph nodes.
  57 .Nm Tee
  58 nodes have four hooks,
  59 .Dv right ,
  60 .Dv left ,
  61 .Dv right2left ,
  62 and
  63 .Dv left2right .
  64 All data received on
  65 .Dv right
  66 is sent unmodified to
  67 .Em both
  68 hooks
  69 .Dv left
  70 and
  71 .Dv right2left .
  72 Similarly, all data received on
  73 .Dv left
  74 is sent unmodified to both
  75 .Dv right
  76 and
  77 .Dv left2right .
  78 .Pp
  79 Packets may also be received on
  80 .Dv right2left
  81 and
  82 .Dv left2right ;
  83 if so, they are forwarded unchanged out hooks
  84 .Dv right
  85 and
  86 .Dv left ,
  87 respectively.
  88 .Sh HOOKS
  89 This node type supports the following hooks:
  90 .Bl -tag -width foobarbarfoo
  91 .It Dv right
  92 The connection to the node on the right.
  93 .It Dv left
  94 The connection to the node on the left.
  95 .It Dv right2left
  96 Tap for right to left traffic.
  97 .It Dv left2right
  98 Tap for left to right traffic.
  99 .El
 100 .Sh CONTROL MESSAGES
 101 This node type supports the generic control messages, plus the following.
 102 .Bl -tag -width foo
 103 .It Dv NGM_TEE_GET_STATS
 104 Get statistics, returned as a
 105 .Dv "struct ng_tee_stats" .
 106 .It Dv NGM_TEE_CLR_STATS
 107 Clear statistics.
 108 .El
 109 .Sh SHUTDOWN
 110 This node shuts down upon receipt of a
 111 .Dv NGM_SHUTDOWN
 112 control message, or when all hooks have been disconnected.
 113 .Sh SEE ALSO
 114 .Xr tee 1 ,
 115 .Xr netgraph 4 ,
 116 .Xr ngctl 8
 117 .Sh HISTORY
 118 The
 119 .Nm
 120 node type was implemented in
 121 .Fx 4.0 .
 122 .Sh AUTHORS
 123 .An Julian Elischer Aq Mt julian@FreeBSD.org