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_sndudata.3nsl
+++ new/usr/src/man/man3nsl/t_sndudata.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_SNDUDATA 3NSL "May 7, 1998"
48 48 .SH NAME
49 49 t_sndudata \- send a data unit
50 50 .SH SYNOPSIS
51 51 .LP
|
↓ open down ↓ |
51 lines elided |
↑ open up ↑ |
52 52 .nf
53 53 #include <xti.h>
54 54
55 55
56 56
57 57
58 58 \fBint\fR \fBt_sndudata\fR(\fBint\fR \fIfd\fR, \fBconst struct t_unitdata *\fR\fIunitdata\fR);
59 59 .fi
60 60
61 61 .SH DESCRIPTION
62 -.sp
63 62 .LP
64 63 This routine is part of the \fBXTI\fR interfaces which evolved from the
65 64 \fBTLI\fR interfaces. \fBXTI\fR represents the future evolution of these
66 65 interfaces. However, \fBTLI\fR interfaces are supported for compatibility. When
67 66 using a \fBTLI\fR routine that has the same name as an \fBXTI\fR routine, the
68 67 \fBtiuser.h\fR header file must be used. Refer to the \fBTLI\fR
69 68 \fBCOMPATIBILITY\fR section for a description of differences between the two
70 69 interfaces.
71 70 .sp
72 71 .LP
73 72 This function is used in connectionless-mode to send a data unit to another
74 73 transport user. The argument \fIfd\fR identifies the local transport endpoint
75 74 through which data will be sent, and \fIunitdata\fR points to a
76 75 \fBt_unitdata\fR structure containing the following members:
77 76 .sp
78 77 .in +2
79 78 .nf
80 79 struct netbuf addr;
81 80 struct netbuf opt;
82 81 struct netbuf udata;
83 82 .fi
84 83 .in -2
85 84
86 85 .sp
87 86 .LP
88 87 In \fIunitdata\fR, \fIaddr\fR specifies the protocol address of the destination
89 88 user, \fIopt\fR identifies options that the user wants associated with this
90 89 request, and \fIudata\fR specifies the user data to be sent. The user may
91 90 choose not to specify what protocol options are associated with the transfer by
92 91 setting the \fIlen\fR field of \fIopt\fR to zero. In this case, the provider
93 92 uses the option values currently set for the communications endpoint.
94 93 .sp
95 94 .LP
96 95 If the \fIlen\fR field of \fIudata\fR is zero, and sending of zero octets is
97 96 not supported by the underlying transport service, the \fBt_sndudata()\fR will
98 97 return -1 with \fBt_errno\fR set to \fBTBADDATA\fR.
99 98 .sp
100 99 .LP
101 100 By default, \fBt_sndudata()\fR operates in synchronous mode and may wait if
102 101 flow control restrictions prevent the data from being accepted by the local
103 102 transport provider at the time the call is made. However, if \fBO_NONBLOCK\fR
104 103 \fBis\fR \fBset\fR \fBby\fR \fBmeans\fR \fBof\fR \fBt_open\fR(3NSL) or
105 104 \fBfcntl\fR(2), \fBt_sndudata()\fR will execute in asynchronous mode and will
106 105 fail under such conditions. The process can arrange to be notified of the
107 106 clearance of a flow control restriction by means of either \fBt_look\fR(3NSL)
108 107 or the EM interface.
109 108 .sp
|
↓ open down ↓ |
37 lines elided |
↑ open up ↑ |
110 109 .LP
111 110 If the amount of data specified in \fIudata\fR exceeds the TSDU size as
112 111 returned in the \fItsdu\fR field of the \fIinfo\fR argument of
113 112 \fBt_open\fR(3NSL) or \fBt_getinfo\fR(3NSL), a \fBTBADDATA\fR error will be
114 113 generated. If \fBt_sndudata()\fR is called before the destination user has
115 114 activated its transport endpoint (see \fBt_bind\fR(3NSL)), the data unit may be
116 115 discarded.
117 116 .sp
118 117 .LP
119 118 If it is not possible for the transport provider to immediately detect the
120 -conditions that cause the errors \fBTBADDADDR\fR and \fBTBADOPT\fR, these
119 +conditions that cause the errors \fBTBADADDR\fR and \fBTBADOPT\fR, these
121 120 errors will alternatively be returned by \fIt_rcvuderr.\fR Therefore, an
122 121 application must be prepared to receive these errors in both of these ways.
123 122 .sp
124 123 .LP
125 124 If the call is interrupted, \fBt_sndudata()\fR will return \fBEINTR\fR and the
126 125 datagram will not be sent.
127 126 .SH RETURN VALUES
128 -.sp
129 127 .LP
130 128 Upon successful completion, a value of \fB0\fR is returned. Otherwise, a
131 129 value of -1 is returned and \fBt_errno\fR is set to indicate an error.
132 130 .SH VALID STATES
133 -.sp
134 131 .LP
135 132 \fBT_IDLE\fR.
136 133 .SH ERRORS
137 -.sp
138 134 .LP
139 135 On failure, \fBt_errno\fR is set to one of the following:
140 136 .sp
141 137 .ne 2
142 138 .na
143 139 \fB\fBTBADADDR\fR\fR
144 140 .ad
145 141 .RS 15n
146 142 The specified protocol address was in an incorrect format or contained illegal
147 143 information.
148 144 .RE
149 145
150 146 .sp
151 147 .ne 2
152 148 .na
153 149 \fB\fBTBADDATA\fR\fR
154 150 .ad
155 151 .RS 15n
156 152 Illegal amount of data. A single send was attempted specifying a TSDU greater
157 153 than that specified in the \fIinfo\fR argument, or a send of a zero byte TSDU
158 154 is not supported by the provider.
159 155 .RE
160 156
161 157 .sp
162 158 .ne 2
163 159 .na
164 160 \fB\fBTBADF\fR\fR
165 161 .ad
166 162 .RS 15n
167 163 The specified file descriptor does not refer to a transport endpoint.
168 164 .RE
169 165
170 166 .sp
171 167 .ne 2
172 168 .na
173 169 \fB\fBTBADOPT\fR\fR
174 170 .ad
175 171 .RS 15n
176 172 The specified options were in an incorrect format or contained illegal
177 173 information.
178 174 .RE
179 175
180 176 .sp
181 177 .ne 2
182 178 .na
183 179 \fB\fBTFLOW\fR\fR
184 180 .ad
185 181 .RS 15n
186 182 \fBO_NONBLOCK\fR was set, but the flow control mechanism prevented the
187 183 transport provider from accepting any data at this time.
188 184 .RE
189 185
190 186 .sp
191 187 .ne 2
192 188 .na
193 189 \fB\fBTLOOK\fR\fR
194 190 .ad
195 191 .RS 15n
196 192 An asynchronous event has occurred on this transport endpoint.
197 193 .RE
198 194
199 195 .sp
200 196 .ne 2
201 197 .na
202 198 \fB\fBTNOTSUPPORT\fR\fR
203 199 .ad
204 200 .RS 15n
205 201 This function is not supported by the underlying transport provider.
206 202 .RE
207 203
208 204 .sp
209 205 .ne 2
210 206 .na
211 207 \fB\fBTOUTSTATE\fR\fR
212 208 .ad
213 209 .RS 15n
214 210 The communications endpoint referenced by \fIfd\fR is not in one of the states
215 211 in which a call to this function is valid.
216 212 .RE
217 213
218 214 .sp
219 215 .ne 2
220 216 .na
221 217 \fB\fBTPROTO\fR\fR
222 218 .ad
223 219 .RS 15n
224 220 This error indicates that a communication problem has been detected between XTI
225 221 and the transport provider for which there is no other suitable XTI error
226 222 \fB(t_errno)\fR.
227 223 .RE
228 224
|
↓ open down ↓ |
81 lines elided |
↑ open up ↑ |
229 225 .sp
230 226 .ne 2
231 227 .na
232 228 \fB\fBTSYSERR\fR\fR
233 229 .ad
234 230 .RS 15n
235 231 A system error has occurred during execution of this function.
236 232 .RE
237 233
238 234 .SH TLI COMPATIBILITY
239 -.sp
240 235 .LP
241 236 The \fBXTI\fR and \fBTLI\fR interface definitions have common names but use
242 237 different header files. This, and other semantic differences between the two
243 238 interfaces are described in the subsections below.
244 239 .SS "Interface Header"
245 -.sp
246 240 .LP
247 241 The \fBXTI\fR interfaces use the header file, \fBxti.h.\fR \fBTLI\fR interfaces
248 242 should \fInot\fR use this header. They should use the header:
249 243 .br
250 244 .in +2
251 245 #include <tiuser.h>
252 246 .in -2
253 247 .SS "Error Description Values"
254 -.sp
255 248 .LP
256 249 The \fBt_errno\fR values that can be set by the \fBXTI\fR interface and cannot
257 250 be set by the \fBTLI\fR interface are:
258 251 .br
259 252 .in +2
260 253 \fBTPROTO\fR
261 254 .in -2
262 255 .br
263 256 .in +2
264 257 \fBTBADADDR\fR
265 258 .in -2
266 259 .br
267 260 .in +2
268 261 \fBTBADOPT\fR
|
↓ open down ↓ |
4 lines elided |
↑ open up ↑ |
269 262 .in -2
270 263 .br
271 264 .in +2
272 265 \fBTLOOK\fR
273 266 .in -2
274 267 .br
275 268 .in +2
276 269 \fBTOUTSTATE\fR
277 270 .in -2
278 271 .SS "Notes"
279 -.sp
280 272 .LP
281 273 Whenever this function fails with \fBt_error\fR set to \fBTFLOW,\fR
282 274 \fBO_NONBLOCK\fR must have been set.
283 275 .SS "Option Buffers"
284 -.sp
285 276 .LP
286 277 The format of the options in an \fBopt\fR buffer is dictated by the transport
287 278 provider. Unlike the \fBXTI\fR interface, the \fBTLI\fR interface does not fix
288 279 the buffer format.
289 280 .SH ATTRIBUTES
290 -.sp
291 281 .LP
292 282 See \fBattributes\fR(5) for descriptions of the following attributes:
293 283 .sp
294 284
295 285 .sp
296 286 .TS
297 287 box;
298 288 c | c
299 289 l | l .
300 290 ATTRIBUTE TYPE ATTRIBUTE VALUE
301 291 _
302 292 MT Level Safe
303 293 .TE
304 294
305 295 .SH SEE ALSO
306 -.sp
307 296 .LP
308 297 \fBfcntl\fR(2), \fBt_alloc\fR(3NSL), \fBt_bind\fR(3NSL), \fBt_error\fR(3NSL),
309 298 \fBt_getinfo\fR(3NSL), \fBt_look\fR(3NSL), \fBt_open\fR(3NSL),
310 299 \fBt_rcvudata\fR(3NSL), \fBt_rcvuderr\fR(3NSL), \fBattributes\fR(5)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX