share/man/man4/ng_split.4

   1 .\" Copyright (c) 2001 FreeBSD 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 FreeBSD Inc.;
   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 FreeBSD
  11 .\"    Inc., Inc. trademarks, including the mark "FREEBSD
  12 .\"    INC." 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 FREEBSD INC. "AS IS", AND
  16 .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, FreeBSD Inc. 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 .\" FreeBSD Inc. 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 FreeBSD Inc. 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 FreeBSD Inc. IS ADVISED OF THE POSSIBILITY
  31 .\" OF SUCH DAMAGE.
  32 .\"
  33 .\" Author: Julian Elischer <julian@FreeBSD.org>
  34 .\"
  35 .\" $FreeBSD$
  36 .\"
  37 .Dd February 19, 2001
  38 .Dt NG_SPLIT 4
  39 .Os
  40 .Sh NAME
  41 .Nm ng_split
  42 .Nd netgraph node to separate incoming and outgoing flows
  43 .Sh SYNOPSIS
  44 .In netgraph/ng_split.h
  45 .Sh DESCRIPTION
  46 The
  47 .Nm split
  48 node type is used to split a bidirectional stream of packets into
  49 two separate unidirectional streams of packets.
  50 .Sh HOOKS
  51 This node type supports the following three hooks:
  52 .Bl -tag -width ".Va mixed"
  53 .It Va in
  54 Packets received on
  55 .Em in
  56 are forwarded to
  57 .Em mixed .
  58 .It Va out
  59 Packets received on
  60 .Em out
  61 will be discarded as illegal.
  62 .It Va mixed
  63 Packets received on
  64 .Em mixed
  65 are forwarded to
  66 .Em out .
  67 .El
  68 .Sh CONTROL MESSAGES
  69 This node type supports only the generic control messages.
  70 .Sh SHUTDOWN
  71 This node shuts down upon receipt of a
  72 .Dv NGM_SHUTDOWN
  73 control message, or when all hooks have been disconnected.
  74 .Sh SEE ALSO
  75 .Xr netgraph 4 ,
  76 .Xr ngctl 8
  77 .Sh HISTORY
  78 The
  79 .Nm
  80 node type was implemented in
  81 .Fx 3.5
  82 but incorporated into
  83 .Fx
  84 in
  85 .Fx 5.0 .
  86 .Sh AUTHORS
  87 .An Julian Elischer Aq julian@FreeBSD.org
  88 .An Vitaly V. Belekhov Aq vitaly@riss-telecom.ru