share/man/man4/ng_hub.4

   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 .\" $FreeBSD$
  26 .\"
  27 .Dd May 5, 2010
  28 .Dt NG_HUB 4
  29 .Os
  30 .Sh NAME
  31 .Nm ng_hub
  32 .Nd packet distribution netgraph node type
  33 .Sh SYNOPSIS
  34 .In netgraph/ng_hub.h
  35 .Sh DESCRIPTION
  36 The
  37 .Nm hub
  38 node type provides a simple mechanism for distributing packets over
  39 several links.
  40 Packets received on any of the hooks are forwarded out the other hooks.
  41 Packets are not altered in any way.
  42 .Sh HOOKS
  43 A
  44 .Nm hub
  45 node accepts any request to connect, regardless of the hook name,
  46 as long as the name is unique.
  47 .Sh CONTROL MESSAGES
  48 This node type supports the generic control messages, plus the
  49 following:
  50 .Bl -tag -width foo
  51 .It Dv NGM_HUB_SET_PERSISTENT
  52 This command sets the persistent flag on the node, and takes no arguments.
  53 .El
  54 .Sh SHUTDOWN
  55 This node shuts down upon receipt of a
  56 .Dv NGM_SHUTDOWN
  57 control message, or when all hooks have been disconnected.  Setting the
  58 persistent flag via a
  59 .Dv NGM_HUB_SET_PERSISTENT
  60 control message disables automatic node shutdown when the last hook gets
  61 disconnected.
  62 .Sh SEE ALSO
  63 .Xr netgraph 4 ,
  64 .Xr ng_bridge 4 ,
  65 .Xr ng_ether 4 ,
  66 .Xr ng_one2many 4 ,
  67 .Xr ngctl 8 ,
  68 .Xr nghook 8
  69 .Sh HISTORY
  70 The
  71 .Nm
  72 node type appeared in
  73 .Fx 5.3 .
  74 .Sh AUTHORS
  75 .An Ruslan Ermilov Aq ru@FreeBSD.org