xref: /freebsd/share/man/man4/ng_split.4 (revision cdee49f9867734b89831039db7f39baa0b1f9412)
1cdee49f9SJulian Elischer.\" Copyright (c) 2001 FreeBSD inc.
2cdee49f9SJulian Elischer.\" All rights reserved.
3cdee49f9SJulian Elischer.\"
4cdee49f9SJulian Elischer.\" Subject to the following obligations and disclaimer of warranty, use and
5cdee49f9SJulian Elischer.\" redistribution of this software, in source or object code forms, with or
6cdee49f9SJulian Elischer.\" without modifications are expressly permitted by FreeBSD Inc.;
7cdee49f9SJulian Elischer.\" provided, however, that:
8cdee49f9SJulian Elischer.\" 1. Any and all reproductions of the source or object code must include the
9cdee49f9SJulian Elischer.\"    copyright notice above and the following disclaimer of warranties; and
10cdee49f9SJulian Elischer.\" 2. No rights are granted, in any manner or form, to use FreeBSD
11cdee49f9SJulian Elischer.\"    Inc., Inc. trademarks, including the mark "FREEBSD
12cdee49f9SJulian Elischer.\"    INC." on advertising, endorsements, or otherwise except as
13cdee49f9SJulian Elischer.\"    such appears in the above copyright notice or in the software.
14cdee49f9SJulian Elischer.\"
15cdee49f9SJulian Elischer.\" THIS SOFTWARE IS BEING PROVIDED BY FREEBSD INC. "AS IS", AND
16cdee49f9SJulian Elischer.\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, FreeBSD Inc. MAKES NO
17cdee49f9SJulian Elischer.\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
18cdee49f9SJulian Elischer.\" INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
19cdee49f9SJulian Elischer.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
20cdee49f9SJulian Elischer.\" FreeBSD Inc. DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
21cdee49f9SJulian Elischer.\" REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
22cdee49f9SJulian Elischer.\" SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
23cdee49f9SJulian Elischer.\" IN NO EVENT SHALL FreeBSD Inc. BE LIABLE FOR ANY DAMAGES
24cdee49f9SJulian Elischer.\" RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
25cdee49f9SJulian Elischer.\" WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
26cdee49f9SJulian Elischer.\" PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
27cdee49f9SJulian Elischer.\" SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
28cdee49f9SJulian Elischer.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29cdee49f9SJulian Elischer.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30cdee49f9SJulian Elischer.\" THIS SOFTWARE, EVEN IF FreeBSD Inc. IS ADVISED OF THE POSSIBILITY
31cdee49f9SJulian Elischer.\" OF SUCH DAMAGE.
32cdee49f9SJulian Elischer.\"
33cdee49f9SJulian Elischer.\" Author: Julian Elischer <julian@FreeBSD.org>
34cdee49f9SJulian Elischer.\"
35cdee49f9SJulian Elischer.\" $FreeBSD$
36cdee49f9SJulian Elischer.\"
37cdee49f9SJulian Elischer.Dd February 19, 2001
38cdee49f9SJulian Elischer.Dt NG_SPLIT 4
39cdee49f9SJulian Elischer.Os FreeBSD
40cdee49f9SJulian Elischer.Sh NAME
41cdee49f9SJulian Elischer.Nm ng_split
42cdee49f9SJulian Elischer.Nd Netgraph node to separate incoming and outgoing flows.
43cdee49f9SJulian Elischer.Sh SYNOPSIS
44cdee49f9SJulian Elischer.Fd #include <netgraph/ng_split.h>
45cdee49f9SJulian Elischer.Sh DESCRIPTION
46cdee49f9SJulian ElischerThe
47cdee49f9SJulian Elischer.Nm split
48cdee49f9SJulian Elischernode type is used to split a bidirectional stream of packets into
49cdee49f9SJulian Elischertwo separate unidirectional streams of packets.
50cdee49f9SJulian Elischer.Pp
51cdee49f9SJulian Elischer.Sh HOOKS
52cdee49f9SJulian ElischerThis node type supports the following three hooks:
53cdee49f9SJulian Elischer.Pp
54cdee49f9SJulian Elischer.Bl -tag -width foobar
55cdee49f9SJulian Elischer.It Dv in
56cdee49f9SJulian ElischerPackets received on
57cdee49f9SJulian Elischer.Em in
58cdee49f9SJulian Elischerare forwarded to
59cdee49f9SJulian Elischer.Em mixed .
60cdee49f9SJulian Elischer.It Dv out
61cdee49f9SJulian ElischerPackets received on
62cdee49f9SJulian Elischer.Em out
63cdee49f9SJulian Elischerwill be discarded as illegal.
64cdee49f9SJulian Elischer.It Dv mixed
65cdee49f9SJulian ElischerPackets received on
66cdee49f9SJulian Elischer.Em mixed
67cdee49f9SJulian Elischerare forwarded to
68cdee49f9SJulian Elischer.Em out .
69cdee49f9SJulian Elischer.El
70cdee49f9SJulian Elischer.Sh CONTROL MESSAGES
71cdee49f9SJulian ElischerThis node type supports only the generic control messages.
72cdee49f9SJulian Elischer.Sh SHUTDOWN
73cdee49f9SJulian ElischerThis node shuts down upon receipt of a
74cdee49f9SJulian Elischer.Dv NGM_SHUTDOWN
75cdee49f9SJulian Elischercontrol message, or when all hooks have been disconnected.
76cdee49f9SJulian Elischer.Sh SEE ALSO
77cdee49f9SJulian Elischer.Xr netgraph 4 ,
78cdee49f9SJulian Elischer.Xr ngctl 8
79cdee49f9SJulian Elischer.Sh HISTORY
80cdee49f9SJulian ElischerThe
81cdee49f9SJulian Elischer.Nm
82cdee49f9SJulian Elischernode type was implemented in
83cdee49f9SJulian Elischer.Fx 3.5
84cdee49f9SJulian Elischerbut incorprated into FreeBSD in
85cdee49f9SJulian Elischer.Fx 5.0 .
86cdee49f9SJulian Elischer.Sh AUTHORS
87cdee49f9SJulian Elischer.An Julian Elischer Aq julian@FreeBSD.org
88cdee49f9SJulian Elischer.An Vitaly V. Belekhov Aq vitaly@riss-telecom.ru
89