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_hole.8,v 1.4 1999/01/25 23:46:26 archie Exp $ 37.\" 38.Dd May 19, 2004 39.Dt NG_HOLE 4 40.Os 41.Sh NAME 42.Nm ng_hole 43.Nd netgraph discard node type 44.Sh SYNOPSIS 45.In sys/types.h 46.In netgraph/ng_hole.h 47.Sh DESCRIPTION 48The 49.Nm hole 50node type silently discards all data and control messages it receives. 51This type is used for testing and debugging. 52.Sh HOOKS 53A 54.Nm 55node accepts any request to connect, regardless of the hook name, 56as long as the name is unique. 57.Sh CONTROL MESSAGES 58This node type supports the generic control messages, plus the 59following: 60.Bl -tag -width foo 61.It Dv NGM_HOLE_GET_STATS Pq Ic getstats 62This command takes an 63.Tn ASCII 64string argument, the hook name, and returns the statistics 65associated with the hook as a 66.Vt "struct ng_hole_hookstat" . 67.It Dv NGM_HOLE_CLR_STATS Pq Ic clrstats 68This command takes an 69.Tn ASCII 70string argument, the hook name, and clears the statistics 71associated with the hook. 72.It Dv NGM_HOLE_GETCLR_STATS Pq Ic getclrstats 73This command is identical to 74.Dv NGM_HOLE_GET_STATS , 75except that the statistics are also atomically cleared. 76.El 77.Sh SHUTDOWN 78This node shuts down upon receipt of a 79.Dv NGM_SHUTDOWN 80control message, or when all hooks have been disconnected. 81.Sh SEE ALSO 82.Xr netgraph 4 , 83.Xr ng_echo 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