share/man/man4/ng_UI.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_UI.4,v 1.9.2.1 2001/12/21 09:00:51 ru Exp $
  36 .\" $DragonFly: src/share/man/man4/ng_UI.4,v 1.2 2003/06/17 04:36:59 dillon Exp $
  37 .\" $Whistle: ng_UI.8,v 1.4 1999/01/25 02:37:56 archie Exp $
  38 .\"
  39 .Dd January 19, 1999
  40 .Dt NG_UI 4
  41 .Os
  42 .Sh NAME
  43 .Nm ng_UI
  44 .Nd UI netgraph node type
  45 .Sh SYNOPSIS
  46 .In netgraph/ng_UI.h
  47 .Sh DESCRIPTION
  48 The
  49 .Nm UI
  50 node type has two hooks,
  51 .Dv upstream
  52 and
  53 .Dv downstream .
  54 Packets received on
  55 .Dv downstream
  56 must have 0x03 (indicating unnumbered information) as their first byte;
  57 if not the packet is dropped. This byte is then stripped and the
  58 remainder of the packet sent out on
  59 .Dv upstream .
  60 .Pp
  61 Conversely, packets received on
  62 .Dv upstream
  63 will have a 0x03 byte prepended to them before being forwarded out on the
  64 .Dv downstream
  65 hook.
  66 .Sh HOOKS
  67 This node type supports the following hooks:
  68 .Pp
  69 .Bl -tag -width foobar
  70 .It Dv downstream
  71 Downstream connection. Packets on this side of the node have a 0x03 as
  72 their first byte.
  73 .It Dv upstream
  74 Upstream connection. Packets on this side of the node have the
  75 initial 0x03 byte stripped off.
  76 .El
  77 .Sh CONTROL MESSAGES
  78 This node type supports only the generic control messages.
  79 .Sh SHUTDOWN
  80 This node shuts down upon receipt of a
  81 .Dv NGM_SHUTDOWN
  82 control message, or when both hooks have been disconnected.
  83 .Sh SEE ALSO
  84 .Xr netgraph 4 ,
  85 .Xr ngctl 8
  86 .Sh HISTORY
  87 The
  88 .Nm
  89 node type was implemented in
  90 .Fx 4.0 .
  91 .Sh AUTHORS
  92 .An Julian Elischer Aq julian@FreeBSD.org