xref: /freebsd/share/man/man4/ng_hub.4 (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1.\" Copyright (c) 2004 Ruslan Ermilov
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd May 5, 2010
26.Dt NG_HUB 4
27.Os
28.Sh NAME
29.Nm ng_hub
30.Nd packet distribution netgraph node type
31.Sh SYNOPSIS
32.In netgraph/ng_hub.h
33.Sh DESCRIPTION
34The
35.Nm hub
36node type provides a simple mechanism for distributing packets over
37several links.
38Packets received on any of the hooks are forwarded out the other hooks.
39Packets are not altered in any way.
40.Sh HOOKS
41A
42.Nm hub
43node accepts any request to connect, regardless of the hook name,
44as long as the name is unique.
45.Sh CONTROL MESSAGES
46This node type supports the generic control messages, plus the
47following:
48.Bl -tag -width foo
49.It Dv NGM_HUB_SET_PERSISTENT Pq Ic setpersistent
50This command sets the persistent flag on the node, and takes no arguments.
51.El
52.Sh SHUTDOWN
53This node shuts down upon receipt of a
54.Dv NGM_SHUTDOWN
55control message, or when all hooks have been disconnected.
56Setting the persistent flag via a
57.Dv NGM_HUB_SET_PERSISTENT
58control message disables automatic node shutdown when the last hook gets
59disconnected.
60.Sh SEE ALSO
61.Xr netgraph 4 ,
62.Xr ng_bridge 4 ,
63.Xr ng_ether 4 ,
64.Xr ng_one2many 4 ,
65.Xr ngctl 8 ,
66.Xr nghook 8
67.Sh HISTORY
68The
69.Nm
70node type appeared in
71.Fx 5.3 .
72.Sh AUTHORS
73.An Ruslan Ermilov Aq Mt ru@FreeBSD.org
74