xref: /freebsd/share/man/man4/ng_UI.4 (revision c1f3e4bf21571a88d4269a87f57e3e4ff2ba3ef6)
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_UI.8,v 1.4 1999/01/25 02:37:56 archie Exp $
37.\"
38.Dd January 19, 1999
39.Dt NG_UI 4
40.Os
41.Sh NAME
42.Nm ng_UI
43.Nd UI netgraph node type
44.Sh SYNOPSIS
45.Fd #include <netgraph/ng_UI.h>
46.Sh DESCRIPTION
47The
48.Nm UI
49node type has two hooks,
50.Dv upstream
51and
52.Dv downstream .
53Packets received on
54.Dv downstream
55must have 0x03 (indicating unnumbered information) as their first byte;
56if not the packet is dropped. This byte is then stripped and the
57remainder of the packet sent out on
58.Dv upstream .
59.Pp
60Conversely, packets received on
61.Dv upstream
62will have a 0x03 byte prepended to them before being forwarded out on the
63.Dv downstream
64hook.
65.Sh HOOKS
66This node type supports the following hooks:
67.Pp
68.Bl -tag -width foobar
69.It Dv downstream
70Downstream connection. Packets on this side of the node have a 0x03 as
71their first byte.
72.It Dv upstream
73Upstream connection. Packets 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 julian@FreeBSD.org
92