Merge remote-tracking branch 'origin/master'
[unleashed/lotheac.git] / share / man / man9s / net_inject_t.9s
blobc787626a6054d38d8218912d45b176dca07f8ac9
1 '\" te
2 .\"  Copyright (c) 2008 Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH NET_INJECT_T 9S "May 1, 2008"
7 .SH NAME
8 net_inject_t \- structure for describing how to transmit a packet
9 .SH SYNOPSIS
10 .LP
11 .nf
12 #include <sys/neti.h>
13 .fi
15 .SH INTERFACE LEVEL
16 .sp
17 .LP
18 Solaris DDI specific (Solaris DDI).
19 .SH DESCRIPTION
20 .sp
21 .LP
22 The \fBnet_inject_t\fR data structure passes information in to \fBnet_inject\fR
23 about how to transmit a packet. Transmit includes sending the packet up into
24 the system as well as out of it.
25 .SH STRUCTURE MEMBERS
26 .sp
27 .in +2
28 .nf
29  mblk_t                  *ni_packet;   /* start of the packet */
30   struct sockaddr_storage ni_addr;      /* address of next hop */
31   phy_if_t                ni_physical;  /* network interface to use */
32 .fi
33 .in -2
35 .sp
36 .ne 2
37 .na
38 \fB\fBni_packet\fR\fR
39 .ad
40 .RS 15n
41 Pointer to the first the \fBmblk_t\fR data structure that makes up this packet.
42 .RE
44 .sp
45 .ne 2
46 .na
47 \fB\fBni_addr\fR\fR
48 .ad
49 .RS 15n
50 This field is only required to be initialized if \fBNI_DIRECT_OUT\fR is being
51 used to transmit the packet. The \fBsockaddr_storage\fR field must be set to
52 indicate whether the destination address contained in the structure is
53 \fBIPv4\fR (cast \fIni_addr\fR to struct \fIsockaddr_in\fR) or \fBIPv6\fR (cast
54 \fIni_addr\fR to struct \fIsockaddr_in6\fR).
55 .RE
57 .sp
58 .ne 2
59 .na
60 \fB\fBni_physical\fR\fR
61 .ad
62 .RS 15n
63 The physical interface where the packet will be injected.
64 .RE
66 .SH ATTRIBUTES
67 .sp
68 .LP
69 See \fBattributes\fR(5) for descriptions of the following attributes:
70 .sp
72 .sp
73 .TS
74 box;
75 c | c
76 l | l .
77 ATTRIBUTE TYPE  ATTRIBUTE VALUE
79 Interface Stability     Committed
80 .TE
82 .SH SEE ALSO
83 .sp
84 .LP
85 \fBnet_inject\fR(9F), \fBnetinfo\fR(9F), \fBattributes\fR(5)