xref: /freebsd/share/man/man4/ng_hole.4 (revision 4cf49a43559ed9fdad601bdcccd2c55963008675)
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.\"
334cf49a43SJulian Elischer.\" Author: Archie Cobbs <archie@whistle.com>
344cf49a43SJulian Elischer.\"
354cf49a43SJulian Elischer.\" $FreeBSD$
364cf49a43SJulian Elischer.\" $Whistle: ng_hole.8,v 1.4 1999/01/25 23:46:26 archie Exp $
374cf49a43SJulian Elischer.\"
384cf49a43SJulian Elischer.Dd January 19, 1999
394cf49a43SJulian Elischer.Dt NG_HOLE 8
404cf49a43SJulian Elischer.Os FreeBSD 3
414cf49a43SJulian Elischer.Sh NAME
424cf49a43SJulian Elischer.Nm ng_hole
434cf49a43SJulian Elischer.Nd netgraph discard node type
444cf49a43SJulian Elischer.Sh SYNOPSIS
454cf49a43SJulian Elischer.Fd #include <netgraph/ng_hole.h>
464cf49a43SJulian Elischer.Sh DESCRIPTION
474cf49a43SJulian ElischerThe
484cf49a43SJulian Elischer.Nm hole
494cf49a43SJulian Elischernode type silently discards all data and control messages it receives.
504cf49a43SJulian ElischerThis type is used for testing and debugging.
514cf49a43SJulian Elischer.Sh HOOKS
524cf49a43SJulian Elischer.Nm Hole
534cf49a43SJulian Elischernodes accept any request to connect, regardless of the hook name,
544cf49a43SJulian Elischeras long as the name is unique.
554cf49a43SJulian Elischer.Sh CONTROL MESSAGES
564cf49a43SJulian ElischerThis node type supports only the generic control messages.
574cf49a43SJulian ElischerOther control messages are silently discarded.
584cf49a43SJulian Elischer.Sh SHUTDOWN
594cf49a43SJulian ElischerThis node shuts down upon receipt of a
604cf49a43SJulian Elischer.Dv NGM_SHUTDOWN
614cf49a43SJulian Elischercontrol message, or when all hooks have been disconnected.
624cf49a43SJulian Elischer.Sh SEE ALSO
634cf49a43SJulian Elischer.Xr netgraph 4 ,
644cf49a43SJulian Elischer.Xr ng_echo 8 ,
654cf49a43SJulian Elischer.Xr ngctl 8 .
664cf49a43SJulian Elischer.Sh AUTHOR
674cf49a43SJulian ElischerJulian Elisher <julian@whistle.com>
68