Print this page
10067 Miscellaneous man page typos
Reviewed by: Robert Mustacchi <rm@joyent.com>
Reviewed by: Andy Fiddaman <andy@omniosce.org>
Reviewed by: Volker A. Brandt <vab@bb-c.de>
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man3nsl/t_sndvudata.3nsl
+++ new/usr/src/man/man3nsl/t_sndvudata.3nsl
1 1 .\"
2 2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
3 3 .\" permission to reproduce portions of its copyrighted documentation.
4 4 .\" Original documentation from The Open Group can be obtained online at
5 5 .\" http://www.opengroup.org/bookstore/.
6 6 .\"
7 7 .\" The Institute of Electrical and Electronics Engineers and The Open
8 8 .\" Group, have given us permission to reprint portions of their
9 9 .\" documentation.
10 10 .\"
11 11 .\" In the following statement, the phrase ``this text'' refers to portions
12 12 .\" of the system documentation.
13 13 .\"
14 14 .\" Portions of this text are reprinted and reproduced in electronic form
15 15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
16 16 .\" Standard for Information Technology -- Portable Operating System
17 17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
18 18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
19 19 .\" Engineers, Inc and The Open Group. In the event of any discrepancy
20 20 .\" between these versions and the original IEEE and The Open Group
21 21 .\" Standard, the original IEEE and The Open Group Standard is the referee
22 22 .\" document. The original Standard can be obtained online at
23 23 .\" http://www.opengroup.org/unix/online.html.
24 24 .\"
25 25 .\" This notice shall appear on any product containing this material.
26 26 .\"
27 27 .\" The contents of this file are subject to the terms of the
28 28 .\" Common Development and Distribution License (the "License").
29 29 .\" You may not use this file except in compliance with the License.
30 30 .\"
31 31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32 32 .\" or http://www.opensolaris.org/os/licensing.
33 33 .\" See the License for the specific language governing permissions
34 34 .\" and limitations under the License.
35 35 .\"
36 36 .\" When distributing Covered Code, include this CDDL HEADER in each
37 37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
38 38 .\" If applicable, add the following below this CDDL HEADER, with the
39 39 .\" fields enclosed by brackets "[]" replaced with your own identifying
40 40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
41 41 .\"
42 42 .\"
43 43 .\" Portions Copyright 1989 AT&T
44 44 .\" Copyright 1994, The X/Open Company Ltd. All Rights Reserved.
45 45 .\" Portions Copyright (c) 1998, Sun Microsystems, Inc. All Rights Reserved.
46 46 .\"
47 47 .TH T_SNDVUDATA 3NSL "Aug 23, 2001"
48 48 .SH NAME
49 49 t_sndvudata \- send a data unit from one or more noncontiguous buffers
50 50 .SH SYNOPSIS
51 51 .LP
52 52 .nf
|
↓ open down ↓ |
52 lines elided |
↑ open up ↑ |
53 53 #include <xti.h>
54 54
55 55
56 56
57 57
58 58 \fBint\fR \fBt_sndvudata\fR(\fBint\fR \fIfd\fR, \fBstruct t_unitdata *\fR\fIunitdata\fR, \fBstruct t_iovec *\fR\fIiov\fR,
59 59 \fBunsigned int\fR \fIiovcount\fR);
60 60 .fi
61 61
62 62 .SH DESCRIPTION
63 -.sp
64 63 .LP
65 64 This function is used in connectionless mode to send a data unit to another
66 65 transport user. The argument \fIfd\fR identifies the local transport endpoint
67 66 through which data will be sent, \fIiovcount\fR contains the number of
68 67 non-contiguous \fIudata\fR buffers and is limited to an implementation-defined
69 68 value given by \fBT_IOV_MAX\fR which is at least 16, and \fIunitdata\fR
70 69 points to a \fBt_unitdata\fR structure containing the following members:
71 70 .sp
72 71 .in +2
73 72 .nf
74 73 struct netbuf addr;
75 74 struct netbuf opt;
76 75 struct netbuf udata;
77 76 .fi
78 77 .in -2
79 78
80 79 .sp
81 80 .LP
82 81 If the limit on \fIiovcount\fR is exceeded, the function fails with
83 82 \fBTBADDATA\fR.
84 83 .sp
85 84 .LP
86 85 In \fBunitdata\fR, \fIaddr\fR specifies the protocol address of the
87 86 destination user, and \fIopt\fR identifies options that the user wants
88 87 associated with this request. The \fIudata\fR field is not used. The user may
89 88 choose not to specify what protocol options are associated with the transfer by
90 89 setting the \fIlen\fR field of \fIopt\fR to zero. In this case, the provider
91 90 may use default options.
92 91 .sp
93 92 .LP
94 93 The data to be sent is identified by \fIiov\fR\fB[0]\fR\fI\fR through \fIiov
95 94 [iovcount-1]\fR\fB\&.\fR
96 95 .sp
97 96 .LP
98 97 Note that the limit on the total number of bytes available in all buffers
99 98 passed:
100 99 .sp
101 100 .in +2
102 101 .nf
103 102 \fIiov(0).iov_len + . . + iov(iovcount-1).iov_len \fR
104 103 .fi
105 104 .in -2
106 105
107 106 .sp
108 107 .LP
109 108 may be constrained by implementation limits. If no other constraint applies, it
110 109 will be limited by \fBINT_MAX\fR. In practice, the availability of memory to an
111 110 application is likely to impose a lower limit on the amount of data that can be
112 111 sent or received using scatter/gather functions.
113 112 .sp
114 113 .LP
115 114 By default, \fBt_sndvudata()\fR operates in synchronous mode and may wait if
116 115 flow control restrictions prevent the data from being accepted by the local
117 116 transport provider at the time the call is made. However, if \fBO_NONBLOCK\fR
118 117 is set by means of \fBt_open\fR(3NSL) or \fBfcntl\fR(2), \fBt_sndvudata()\fR
119 118 executes in asynchronous mode and will fail under such conditions. The process
120 119 can arrange to be notified of the clearance of a flow control restriction by
121 120 means of either \fBt_look\fR(3NSL) or the EM interface.
122 121 .sp
123 122 .LP
|
↓ open down ↓ |
50 lines elided |
↑ open up ↑ |
124 123 If the amount of data specified in \fIiov\fR\fB0\fR\fI\fR through \fIiov
125 124 [iovcount-1]\fR exceeds the TSDU size as returned in the \fItsdu\fR field of
126 125 the \fIinfo\fR argument of \fBt_open\fR(3NSL) or \fBt_getinfo\fR(3NSL), or is
127 126 zero and sending of zero octets is not supported by the underlying transport
128 127 service, a \fBTBADDATA\fR error is generated. If \fBt_sndvudata()\fR is
129 128 called before the destination user has activated its transport endpoint (see
130 129 \fBt_bind\fR(3NSL)\|), the data unit may be discarded.
131 130 .sp
132 131 .LP
133 132 If it is not possible for the transport provider to immediately detect the
134 -conditions that cause the errors \fBTBADDADDR\fR and \fBTBADOPT\fR, these
133 +conditions that cause the errors \fBTBADADDR\fR and \fBTBADOPT\fR, these
135 134 errors will alternatively be returned by \fBt_rcvuderr\fR(3NSL). An
136 135 application must therefore be prepared to receive these errors in both of these
137 136 ways.
138 137 .SH RETURN VALUES
139 -.sp
140 138 .LP
141 139 Upon successful completion, a value of \fB0\fR is returned. Otherwise, a value
142 140 of -1 is returned and \fBt_errno\fR is set to indicate an error.
143 141 .SH VALID STATES
144 -.sp
145 142 .LP
146 143 \fBT_IDLE\fR.
147 144 .SH ERRORS
148 -.sp
149 145 .LP
150 146 On failure, \fBt_errno\fR is set to one of the following:
151 147 .sp
152 148 .ne 2
153 149 .na
154 150 \fB\fBTBADADDR\fR\fR
155 151 .ad
156 152 .RS 15n
157 153 The specified protocol address was in an incorrect format or contained illegal
158 154 information.
159 155 .RE
160 156
161 157 .sp
162 158 .ne 2
163 159 .na
164 160 \fB\fBTBADDATA\fR\fR
165 161 .ad
166 162 .RS 15n
167 163 Illegal amount of data.
168 164 .RS +4
169 165 .TP
170 166 .ie t \(bu
171 167 .el o
172 168 A single send was attempted specifying a TSDU greater than that specified in
173 169 the \fIinfo\fR argument, or a send of a zero byte TSDU is not supported by the
174 170 provider.
175 171 .RE
176 172 .RS +4
177 173 .TP
178 174 .ie t \(bu
179 175 .el o
180 176 \fIiovcount\fR is greater than \fBT_IOV_MAX.\fR
181 177 .RE
182 178 .RE
183 179
184 180 .sp
185 181 .ne 2
186 182 .na
187 183 \fB\fBTBADF\fR\fR
188 184 .ad
189 185 .RS 15n
190 186 The specified file descriptor does not refer to a transport endpoint.
191 187 .RE
192 188
193 189 .sp
194 190 .ne 2
195 191 .na
196 192 \fB\fBTBADOPT\fR\fR
197 193 .ad
198 194 .RS 15n
199 195 The specified options were in an incorrect format or contained illegal
200 196 information.
201 197 .RE
202 198
203 199 .sp
204 200 .ne 2
205 201 .na
206 202 \fB\fBTFLOW\fR\fR
207 203 .ad
208 204 .RS 15n
209 205 \fBO_NONBLOCK\fR \fBi\fR was set, but the flow control mechanism prevented the
210 206 transport provider from accepting any data at this time.
211 207 .RE
212 208
213 209 .sp
214 210 .ne 2
215 211 .na
216 212 \fB\fBTLOOK\fR\fR
217 213 .ad
218 214 .RS 15n
219 215 An asynchronous event has occurred on this transport endpoint.
220 216 .RE
221 217
222 218 .sp
223 219 .ne 2
224 220 .na
225 221 \fB\fBTNOTSUPPORT\fR\fR
226 222 .ad
227 223 .RS 15n
228 224 This function is not supported by the underlying transport provider.
229 225 .RE
230 226
231 227 .sp
232 228 .ne 2
233 229 .na
234 230 \fB\fBTOUTSTATE\fR\fR
235 231 .ad
236 232 .RS 15n
237 233 The communications endpoint referenced by \fIfd\fR is not in one of the states
238 234 in which a call to this function is valid.
239 235 .RE
240 236
241 237 .sp
242 238 .ne 2
243 239 .na
244 240 \fB\fBTPROTO\fR\fR
245 241 .ad
246 242 .RS 15n
247 243 This error indicates that a communication problem has been detected between XTI
248 244 and the transport provider for which there is no other suitable XTI error
249 245 \fB(t_errno)\fR.
250 246 .RE
251 247
|
↓ open down ↓ |
93 lines elided |
↑ open up ↑ |
252 248 .sp
253 249 .ne 2
254 250 .na
255 251 \fB\fBTSYSERR\fR\fR
256 252 .ad
257 253 .RS 15n
258 254 A system error has occurred during execution of this function.
259 255 .RE
260 256
261 257 .SH TLI COMPATIBILITY
262 -.sp
263 258 .LP
264 259 In the \fBTLI\fR interface definition, no counterpart of this routine was
265 260 defined.
266 261 .SH ATTRIBUTES
267 -.sp
268 262 .LP
269 263 See \fBattributes\fR(5) for descriptions of the following attributes:
270 264 .sp
271 265
272 266 .sp
273 267 .TS
274 268 box;
275 269 c | c
276 270 l | l .
277 271 ATTRIBUTE TYPE ATTRIBUTE VALUE
278 272 _
279 273 MT Level Safe
280 274 .TE
281 275
282 276 .SH SEE ALSO
283 -.sp
284 277 .LP
285 278 \fBfcntl\fR(2), \fBt_alloc\fR(3NSL), \fBt_open\fR(3NSL),
286 279 \fBt_rcvudata\fR(3NSL), \fBt_rcvvudata\fR(3NSL) \fBt_rcvuderr\fR(3NSL),
287 280 \fBt_sndudata\fR(3NSL), \fBattributes\fR(5)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX