xref: /freebsd/share/man/man4/ng_ether_echo.4 (revision 7899f917b1c0ea178f1d2be0cfb452086d079d23)
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_echo.8,v 1.4 1999/01/25 23:46:26 archie Exp $
35.\"
36.Dd December 24, 2008
37.Dt NG_ETHER_ECHO 4
38.Os
39.Sh NAME
40.Nm ng_ether_echo
41.Nd netgraph ether_echo node type
42.Sh SYNOPSIS
43.In netgraph/ng_ether_echo.h
44.Sh DESCRIPTION
45The
46.Nm ether_echo
47node type reflects all data and control messages back to the sender.
48It assumes (and does not check) that the packet is an ethernet frame,
49and swaps the source and destination addresses before echoing it.
50This node type is used for testing and debugging.
51.Sh HOOKS
52A
53.Nm ether_echo
54node accepts any request to connect, regardless of the hook name,
55as long as the name is unique.
56.Sh CONTROL MESSAGES
57This node type supports only the generic control messages.
58Any other control messages are reflected back to the sender.
59.Sh SHUTDOWN
60This node shuts down upon receipt of a
61.Dv NGM_SHUTDOWN
62control message, or when all hooks have been disconnected.
63.Sh SEE ALSO
64.Xr netgraph 4 ,
65.Xr ng_echo 4 ,
66.Xr ng_ether 4 ,
67.Xr ng_hole 4 ,
68.Xr ngctl 8
69.Sh HISTORY
70The
71.Nm
72node type was implemented in
73.Fx 8.0 .
74.Sh AUTHORS
75.An Julian Elischer Aq Mt julian@FreeBSD.org
76