xref: /freebsd/share/man/man4/ng_UI.4 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
14cf49a43SJulian Elischer.\" Copyright (c) 1996-1999 Whistle Communications, Inc.
24cf49a43SJulian Elischer.\" All rights reserved.
34cf49a43SJulian Elischer.\"
44cf49a43SJulian Elischer.\" Subject to the following obligations and disclaimer of warranty, use and
54cf49a43SJulian Elischer.\" redistribution of this software, in source or object code forms, with or
64cf49a43SJulian Elischer.\" without modifications are expressly permitted by Whistle Communications;
74cf49a43SJulian Elischer.\" provided, however, that:
84cf49a43SJulian Elischer.\" 1. Any and all reproductions of the source or object code must include the
94cf49a43SJulian Elischer.\"    copyright notice above and the following disclaimer of warranties; and
104cf49a43SJulian Elischer.\" 2. No rights are granted, in any manner or form, to use Whistle
114cf49a43SJulian Elischer.\"    Communications, Inc. trademarks, including the mark "WHISTLE
124cf49a43SJulian Elischer.\"    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
134cf49a43SJulian Elischer.\"    such appears in the above copyright notice or in the software.
144cf49a43SJulian Elischer.\"
154cf49a43SJulian Elischer.\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
164cf49a43SJulian Elischer.\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
174cf49a43SJulian Elischer.\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
184cf49a43SJulian Elischer.\" INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
194cf49a43SJulian Elischer.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
204cf49a43SJulian Elischer.\" WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
214cf49a43SJulian Elischer.\" REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
224cf49a43SJulian Elischer.\" SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
234cf49a43SJulian Elischer.\" IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
244cf49a43SJulian Elischer.\" RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
254cf49a43SJulian Elischer.\" WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
264cf49a43SJulian Elischer.\" PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
274cf49a43SJulian Elischer.\" SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
284cf49a43SJulian Elischer.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
294cf49a43SJulian Elischer.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
304cf49a43SJulian Elischer.\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
314cf49a43SJulian Elischer.\" OF SUCH DAMAGE.
324cf49a43SJulian Elischer.\"
33eddc45e7SJeroen Ruigrok van der Werven.\" Author: Archie Cobbs <archie@FreeBSD.org>
344cf49a43SJulian Elischer.\" $Whistle: ng_UI.8,v 1.4 1999/01/25 02:37:56 archie Exp $
354cf49a43SJulian Elischer.\"
364cf49a43SJulian Elischer.Dd January 19, 1999
37bec35b9aSArchie Cobbs.Dt NG_UI 4
383d45e180SRuslan Ermilov.Os
394cf49a43SJulian Elischer.Sh NAME
404cf49a43SJulian Elischer.Nm ng_UI
414cf49a43SJulian Elischer.Nd UI netgraph node type
424cf49a43SJulian Elischer.Sh SYNOPSIS
4332eef9aeSRuslan Ermilov.In netgraph/ng_UI.h
444cf49a43SJulian Elischer.Sh DESCRIPTION
454cf49a43SJulian ElischerThe
464cf49a43SJulian Elischer.Nm UI
474cf49a43SJulian Elischernode type has two hooks,
484cf49a43SJulian Elischer.Dv upstream
494cf49a43SJulian Elischerand
504cf49a43SJulian Elischer.Dv downstream .
514cf49a43SJulian ElischerPackets received on
524cf49a43SJulian Elischer.Dv downstream
534cf49a43SJulian Elischermust have 0x03 (indicating unnumbered information) as their first byte;
545203edcdSRuslan Ermilovif not the packet is dropped.
555203edcdSRuslan ErmilovThis byte is then stripped and the
564cf49a43SJulian Elischerremainder of the packet sent out on
574cf49a43SJulian Elischer.Dv upstream .
584cf49a43SJulian Elischer.Pp
594cf49a43SJulian ElischerConversely, packets received on
604cf49a43SJulian Elischer.Dv upstream
614cf49a43SJulian Elischerwill have a 0x03 byte prepended to them before being forwarded out on the
624cf49a43SJulian Elischer.Dv downstream
634cf49a43SJulian Elischerhook.
644cf49a43SJulian Elischer.Sh HOOKS
654cf49a43SJulian ElischerThis node type supports the following hooks:
66c60bda17SJoel Dahl.Bl -tag -width ".Va downstream"
67c60bda17SJoel Dahl.It Va downstream
685203edcdSRuslan ErmilovDownstream connection.
695203edcdSRuslan ErmilovPackets on this side of the node have a 0x03 as
704cf49a43SJulian Elischertheir first byte.
71c60bda17SJoel Dahl.It Va upstream
725203edcdSRuslan ErmilovUpstream connection.
735203edcdSRuslan ErmilovPackets on this side of the node have the
744cf49a43SJulian Elischerinitial 0x03 byte stripped off.
754cf49a43SJulian Elischer.El
764cf49a43SJulian Elischer.Sh CONTROL MESSAGES
774cf49a43SJulian ElischerThis node type supports only the generic control messages.
784cf49a43SJulian Elischer.Sh SHUTDOWN
794cf49a43SJulian ElischerThis node shuts down upon receipt of a
804cf49a43SJulian Elischer.Dv NGM_SHUTDOWN
814cf49a43SJulian Elischercontrol message, or when both hooks have been disconnected.
824cf49a43SJulian Elischer.Sh SEE ALSO
834cf49a43SJulian Elischer.Xr netgraph 4 ,
84bec35b9aSArchie Cobbs.Xr ngctl 8
8551291597SJulian Elischer.Sh HISTORY
8651291597SJulian ElischerThe
8751291597SJulian Elischer.Nm
8851291597SJulian Elischernode type was implemented in
8951291597SJulian Elischer.Fx 4.0 .
9051291597SJulian Elischer.Sh AUTHORS
91*6c899950SBaptiste Daroussin.An Julian Elischer Aq Mt julian@FreeBSD.org
92