xref: /freebsd/share/man/man4/ng_split.4 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
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.Dd February 19, 2001
36cdee49f9SJulian Elischer.Dt NG_SPLIT 4
373d45e180SRuslan Ermilov.Os
38cdee49f9SJulian Elischer.Sh NAME
39cdee49f9SJulian Elischer.Nm ng_split
4040d366d1SRuslan Ermilov.Nd netgraph node to separate incoming and outgoing flows
41cdee49f9SJulian Elischer.Sh SYNOPSIS
4232eef9aeSRuslan Ermilov.In netgraph/ng_split.h
43cdee49f9SJulian Elischer.Sh DESCRIPTION
44cdee49f9SJulian ElischerThe
45cdee49f9SJulian Elischer.Nm split
46cdee49f9SJulian Elischernode type is used to split a bidirectional stream of packets into
47cdee49f9SJulian Elischertwo separate unidirectional streams of packets.
48cdee49f9SJulian Elischer.Sh HOOKS
49cdee49f9SJulian ElischerThis node type supports the following three hooks:
50c60bda17SJoel Dahl.Bl -tag -width ".Va mixed"
51c60bda17SJoel Dahl.It Va in
52cdee49f9SJulian ElischerPackets received on
53cdee49f9SJulian Elischer.Em in
54cdee49f9SJulian Elischerare forwarded to
55cdee49f9SJulian Elischer.Em mixed .
56c60bda17SJoel Dahl.It Va out
57cdee49f9SJulian ElischerPackets received on
58cdee49f9SJulian Elischer.Em out
59cdee49f9SJulian Elischerwill be discarded as illegal.
60c60bda17SJoel Dahl.It Va mixed
61cdee49f9SJulian ElischerPackets received on
62cdee49f9SJulian Elischer.Em mixed
63cdee49f9SJulian Elischerare forwarded to
64cdee49f9SJulian Elischer.Em out .
65cdee49f9SJulian Elischer.El
66cdee49f9SJulian Elischer.Sh CONTROL MESSAGES
67cdee49f9SJulian ElischerThis node type supports only the generic control messages.
68cdee49f9SJulian Elischer.Sh SHUTDOWN
69cdee49f9SJulian ElischerThis node shuts down upon receipt of a
70cdee49f9SJulian Elischer.Dv NGM_SHUTDOWN
71cdee49f9SJulian Elischercontrol message, or when all hooks have been disconnected.
72cdee49f9SJulian Elischer.Sh SEE ALSO
73cdee49f9SJulian Elischer.Xr netgraph 4 ,
74cdee49f9SJulian Elischer.Xr ngctl 8
75cdee49f9SJulian Elischer.Sh HISTORY
76cdee49f9SJulian ElischerThe
77cdee49f9SJulian Elischer.Nm
78cdee49f9SJulian Elischernode type was implemented in
79cdee49f9SJulian Elischer.Fx 3.5
80f87717faSMike Pritchardbut incorporated into
8140d366d1SRuslan Ermilov.Fx
8240d366d1SRuslan Ermilovin
83cdee49f9SJulian Elischer.Fx 5.0 .
84cdee49f9SJulian Elischer.Sh AUTHORS
85*6c899950SBaptiste Daroussin.An Julian Elischer Aq Mt julian@FreeBSD.org
86*6c899950SBaptiste Daroussin.An Vitaly V. Belekhov Aq Mt vitaly@riss-telecom.ru
87