xref: /freebsd/share/man/man4/ng_split.4 (revision 59c8e88e72633afbc47a4ace0d2170d00d51f7dc)
1.\" Copyright (c) 2001 FreeBSD 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 FreeBSD Inc.;
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 FreeBSD
11.\"    Inc., Inc. trademarks, including the mark "FREEBSD
12.\"    INC." 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 FREEBSD INC. "AS IS", AND
16.\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, FreeBSD Inc. 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.\" FreeBSD Inc. 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 FreeBSD Inc. 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 FreeBSD Inc. IS ADVISED OF THE POSSIBILITY
31.\" OF SUCH DAMAGE.
32.\"
33.\" Author: Julian Elischer <julian@FreeBSD.org>
34.\"
35.Dd February 19, 2001
36.Dt NG_SPLIT 4
37.Os
38.Sh NAME
39.Nm ng_split
40.Nd netgraph node to separate incoming and outgoing flows
41.Sh SYNOPSIS
42.In netgraph/ng_split.h
43.Sh DESCRIPTION
44The
45.Nm split
46node type is used to split a bidirectional stream of packets into
47two separate unidirectional streams of packets.
48.Sh HOOKS
49This node type supports the following three hooks:
50.Bl -tag -width ".Va mixed"
51.It Va in
52Packets received on
53.Em in
54are forwarded to
55.Em mixed .
56.It Va out
57Packets received on
58.Em out
59will be discarded as illegal.
60.It Va mixed
61Packets received on
62.Em mixed
63are forwarded to
64.Em out .
65.El
66.Sh CONTROL MESSAGES
67This node type supports only the generic control messages.
68.Sh SHUTDOWN
69This node shuts down upon receipt of a
70.Dv NGM_SHUTDOWN
71control message, or when all hooks have been disconnected.
72.Sh SEE ALSO
73.Xr netgraph 4 ,
74.Xr ngctl 8
75.Sh HISTORY
76The
77.Nm
78node type was implemented in
79.Fx 3.5
80but incorporated into
81.Fx
82in
83.Fx 5.0 .
84.Sh AUTHORS
85.An Julian Elischer Aq Mt julian@FreeBSD.org
86.An Vitaly V. Belekhov Aq Mt vitaly@riss-telecom.ru
87