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.man.txt
+++ new/usr/src/man/man3nsl/t_sndvudata.3nsl.man.txt
1 1 T_SNDVUDATA(3NSL) Networking Services Library Functions T_SNDVUDATA(3NSL)
2 2
3 3
4 4
5 5 NAME
6 6 t_sndvudata - send a data unit from one or more noncontiguous buffers
7 7
8 8 SYNOPSIS
9 9 #include <xti.h>
10 10
11 11
12 12
13 13
14 14 int t_sndvudata(int fd, struct t_unitdata *unitdata, struct t_iovec *iov,
15 15 unsigned int iovcount);
16 16
17 17
18 18 DESCRIPTION
19 19 This function is used in connectionless mode to send a data unit to
20 20 another transport user. The argument fd identifies the local
21 21 transport endpoint through which data will be sent, iovcount contains
22 22 the number of non-contiguous udata buffers and is limited to an
23 23 implementation-defined value given by T_IOV_MAX which is at least 16,
24 24 and unitdata points to a t_unitdata structure containing the
25 25 following members:
26 26
27 27 struct netbuf addr;
28 28 struct netbuf opt;
29 29 struct netbuf udata;
30 30
31 31
32 32
33 33 If the limit on iovcount is exceeded, the function fails with
34 34 TBADDATA.
35 35
36 36
37 37 In unitdata, addr specifies the protocol address of the destination
38 38 user, and opt identifies options that the user wants associated with
39 39 this request. The udata field is not used. The user may choose not to
40 40 specify what protocol options are associated with the transfer by
41 41 setting the len field of opt to zero. In this case, the provider may
42 42 use default options.
43 43
44 44
45 45 The data to be sent is identified by iov[0] through iov [iovcount-1].
46 46
47 47
48 48 Note that the limit on the total number of bytes available in all
49 49 buffers passed:
50 50
51 51 iov(0).iov_len + . . + iov(iovcount-1).iov_len
52 52
53 53
54 54
55 55 may be constrained by implementation limits. If no other constraint
56 56 applies, it will be limited by INT_MAX. In practice, the availability
57 57 of memory to an application is likely to impose a lower limit on the
58 58 amount of data that can be sent or received using scatter/gather
59 59 functions.
60 60
61 61
62 62 By default, t_sndvudata() operates in synchronous mode and may wait if
63 63 flow control restrictions prevent the data from being accepted by the
64 64 local transport provider at the time the call is made. However, if
65 65 O_NONBLOCK is set by means of t_open(3NSL) or fcntl(2), t_sndvudata()
66 66 executes in asynchronous mode and will fail under such conditions. The
67 67 process can arrange to be notified of the clearance of a flow control
68 68 restriction by means of either t_look(3NSL) or the EM interface.
69 69
70 70
|
↓ open down ↓ |
70 lines elided |
↑ open up ↑ |
71 71 If the amount of data specified in iov0 through iov [iovcount-1]
72 72 exceeds the TSDU size as returned in the tsdu field of the info
73 73 argument of t_open(3NSL) or t_getinfo(3NSL), or is zero and sending of
74 74 zero octets is not supported by the underlying transport service, a
75 75 TBADDATA error is generated. If t_sndvudata() is called before the
76 76 destination user has activated its transport endpoint (see
77 77 t_bind(3NSL)), the data unit may be discarded.
78 78
79 79
80 80 If it is not possible for the transport provider to immediately detect
81 - the conditions that cause the errors TBADDADDR and TBADOPT, these
82 - errors will alternatively be returned by t_rcvuderr(3NSL). An
83 - application must therefore be prepared to receive these errors in both
84 - of these ways.
81 + the conditions that cause the errors TBADADDR and TBADOPT, these errors
82 + will alternatively be returned by t_rcvuderr(3NSL). An application
83 + must therefore be prepared to receive these errors in both of these
84 + ways.
85 85
86 86 RETURN VALUES
87 87 Upon successful completion, a value of 0 is returned. Otherwise, a
88 88 value of -1 is returned and t_errno is set to indicate an error.
89 89
90 90 VALID STATES
91 91 T_IDLE.
92 92
93 93 ERRORS
94 94 On failure, t_errno is set to one of the following:
95 95
96 96 TBADADDR
97 97 The specified protocol address was in an incorrect
98 98 format or contained illegal information.
99 99
100 100
101 101 TBADDATA
102 102 Illegal amount of data.
103 103
104 104 o A single send was attempted specifying a TSDU
105 105 greater than that specified in the info
106 106 argument, or a send of a zero byte TSDU is
107 107 not supported by the provider.
108 108
109 109 o iovcount is greater than T_IOV_MAX.
110 110
111 111
112 112 TBADF
113 113 The specified file descriptor does not refer to a
114 114 transport endpoint.
115 115
116 116
117 117 TBADOPT
118 118 The specified options were in an incorrect format or
119 119 contained illegal information.
120 120
121 121
122 122 TFLOW
123 123 O_NONBLOCK i was set, but the flow control mechanism
124 124 prevented the transport provider from accepting any data
125 125 at this time.
126 126
127 127
128 128 TLOOK
129 129 An asynchronous event has occurred on this transport
130 130 endpoint.
131 131
132 132
133 133 TNOTSUPPORT
134 134 This function is not supported by the underlying
135 135 transport provider.
136 136
137 137
138 138 TOUTSTATE
139 139 The communications endpoint referenced by fd is not in
140 140 one of the states in which a call to this function is
141 141 valid.
142 142
143 143
144 144 TPROTO
145 145 This error indicates that a communication problem has
146 146 been detected between XTI and the transport provider for
147 147 which there is no other suitable XTI error (t_errno).
148 148
149 149
150 150 TSYSERR
151 151 A system error has occurred during execution of this
152 152 function.
153 153
154 154
155 155 TLI COMPATIBILITY
156 156 In the TLI interface definition, no counterpart of this routine was
157 157 defined.
158 158
159 159 ATTRIBUTES
160 160 See attributes(5) for descriptions of the following attributes:
161 161
162 162
163 163
164 164
165 165 +---------------+-----------------+
166 166 |ATTRIBUTE TYPE | ATTRIBUTE VALUE |
167 167 +---------------+-----------------+
168 168 |MT Level | Safe |
169 169 +---------------+-----------------+
170 170
171 171 SEE ALSO
172 172 fcntl(2), t_alloc(3NSL), t_open(3NSL), t_rcvudata(3NSL),
173 173 t_rcvvudata(3NSL) t_rcvuderr(3NSL), t_sndudata(3NSL), attributes(5)
174 174
175 175
176 176
177 177 August 23, 2001 T_SNDVUDATA(3NSL)
|
↓ open down ↓ |
83 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX