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