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$
  36 .\" $Whistle: ng_tee.8,v 1.4 1999/01/25 23:46:27 archie Exp $
  37 .\"
  38 .Dd May 28, 2004
  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 sys/types.h
  46 .In netgraph/ng_tee.h
  47 .Sh DESCRIPTION
  48 The
  49 .Nm tee
  50 node type has a purpose similar to the
  51 .Xr tee 1
  52 command.
  53 .Nm Tee
  54 nodes are useful for debugging or
  55 .Dq snooping
  56 on a connection
  57 between two netgraph nodes.
  58 .Nm Tee
  59 nodes have four hooks,
  60 .Dv right ,
  61 .Dv left ,
  62 .Dv right2left ,
  63 and
  64 .Dv left2right .
  65 All data received on
  66 .Dv right
  67 is sent unmodified to
  68 .Em both
  69 hooks
  70 .Dv left
  71 and
  72 .Dv right2left .
  73 Similarly, all data received on
  74 .Dv left
  75 is sent unmodified to both
  76 .Dv right
  77 and
  78 .Dv left2right .
  79 .Pp
  80 Packets may also be received on
  81 .Dv right2left
  82 and
  83 .Dv left2right ;
  84 if so, they are forwarded unchanged out hooks
  85 .Dv right
  86 and
  87 .Dv left ,
  88 respectively.
  89 .Sh HOOKS
  90 This node type supports the following hooks:
  91 .Bl -tag -width ".Va left2right"
  92 .It Va right
  93 The connection to the node on the right.
  94 .It Va left
  95 The connection to the node on the left.
  96 .It Va right2left
  97 Tap for right to left traffic.
  98 .It Va left2right
  99 Tap for left to right traffic.
 100 .El
 101 .Sh CONTROL MESSAGES
 102 This node type supports the generic control messages, plus the following.
 103 .Bl -tag -width foo
 104 .It Dv NGM_TEE_GET_STATS Pq Ic getstats
 105 Get statistics, returned as a
 106 .Dv "struct ng_tee_stats" .
 107 .It Dv NGM_TEE_CLR_STATS Pq Ic clrstats
 108 Clear statistics.
 109 .El
 110 .Sh SHUTDOWN
 111 This node shuts down upon receipt of an
 112 .Dv NGM_SHUTDOWN
 113 control message, or when all hooks have been disconnected.
 114 If both
 115 .Dv right
 116 and
 117 .Dv left
 118 hooks are present, node removes itself from the chain gently,
 119 connecting
 120 .Dv right
 121 and
 122 .Dv left
 123 together.
 124 .Sh SEE ALSO
 125 .Xr tee 1 ,
 126 .Xr netgraph 4 ,
 127 .Xr ngctl 8
 128 .Sh HISTORY
 129 The
 130 .Nm
 131 node type was implemented in
 132 .Fx 4.0 .
 133 .Sh AUTHORS
 134 .An Julian Elischer Aq julian@FreeBSD.org