| blob | cd4a75ec25c236daa1a5567195de3008b73fea53 |
1 '\" te
2 .\" Copyright 1994, The X/Open Company Ltd. All Rights Reserved Portions Copyright 1989 AT&T Portions Copyright (c) 1998, Sun Microsystems, Inc. All Rights Reserved
3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
4 .\" http://www.opengroup.org/bookstore/.
5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
6 .\" This notice shall appear on any product containing this material.
7 .\" 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.
8 .\" 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.
9 .\" 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]
10 .TH T_GETINFO 3NSL "May 7, 1998"
11 .SH NAME
12 t_getinfo \- get protocol-specific service information
13 .SH SYNOPSIS
14 .LP
15 .nf
16 #include <xti.h>
20 \fBint\fR \fBt_getinfo\fR(\fBint\fR \fIfd\fR, \fBstruct t_info *\fR\fIinfo\fR);
21 .fi
23 .SH DESCRIPTION
24 .sp
25 .LP
26 This routine is part of the \fBXTI\fR interfaces which evolved from the
27 \fBTLI\fR interfaces. \fBXTI\fR represents the future evolution of these
28 interfaces. However, \fBTLI\fR interfaces are supported for compatibility. When
29 using a \fBTLI\fR routine that has the same name as an \fBXTI\fR routine, the
30 \fBtiuser.h\fR header file must be used. Refer to the \fBTLI\fR
31 \fBCOMPATIBILITY\fR section for a description of differences between the two
32 interfaces.
33 .sp
34 .LP
35 This function returns the current characteristics of the underlying transport
36 protocol and/or transport connection associated with file descriptor \fIfd\fR.
37 The \fIinfo\fR pointer is used to return the same information returned by
38 \fBt_open\fR(3NSL), although not necessarily precisely the same values. This
39 function enables a transport user to access this information during any phase
40 of communication.
41 .sp
42 .LP
43 This argument points to a \fBt_info\fR structure which contains the following
44 members:
45 .sp
46 .in +2
47 .nf
48 t_scalar_t addr; /*max size in octets of the transport protocol address*/
49 t_scalar_t options; /*max number of bytes of protocol-specific options */
50 t_scalar_t tsdu; /*max size in octets of a transport service data unit */
51 t_scalar_t etsdu; /*max size in octets of an expedited transport service*/
52 /*data unit (ETSDU) */
53 t_scalar_t connect; /*max number of octets allowed on connection */
54 /*establishment functions */
55 t_scalar_t discon; /*max number of octets of data allowed on t_snddis() */
56 /*and t_rcvdis() functions */
57 t_scalar_t servtype; /*service type supported by the transport provider */
58 t_scalar_t flags; /*other info about the transport provider */
59 .fi
60 .in -2
62 .sp
63 .LP
64 The values of the fields have the following meanings:
65 .sp
66 .ne 2
67 .na
68 \fB\fIaddr\fR\fR
69 .ad
70 .RS 12n
71 A value greater than zero indicates the maximum size of a transport protocol
72 address and a value of \fBT_INVALID\fR (-2) specifies that the transport
73 provider does not provide user access to transport protocol addresses.
74 .RE
76 .sp
77 .ne 2
78 .na
79 \fB\fIoptions\fR\fR
80 .ad
81 .RS 12n
82 A value greater than zero indicates the maximum number of bytes of
83 protocol-specific options supported by the provider, and a value of
84 \fBT_INVALID\fR (-2) specifies that the transport provider does not support
85 user-settable options.
86 .RE
88 .sp
89 .ne 2
90 .na
91 \fB\fItsdu\fR\fR
92 .ad
93 .RS 12n
94 A value greater than zero specifies the maximum size in octets of a transport
95 service data unit (TSDU); a value of \fBT_NULL\fR (zero) specifies that the
96 transport provider does not support the concept of TSDU, although it does
97 support the sending of a datastream with no logical boundaries preserved across
98 a connection; a value of \fBT_INFINITE\fR (-1) specifies that there is no
99 limit on the size in octets of a TSDU; and a value of \fBT_INVALID\fR (-2)
100 specifies that the transfer of normal data is not supported by the transport
101 provider.
102 .RE
104 .sp
105 .ne 2
106 .na
107 \fB\fIetsdu\fR\fR
108 .ad
109 .RS 12n
110 A value greater than zero specifies the maximum size in octets of an expedited
111 transport service data unit (ETSDU); a value of \fBT_NULL\fR (zero) specifies
112 that the transport provider does not support the concept of ETSDU, although it
113 does support the sending of an expedited data stream with no logical boundaries
114 preserved across a connection; a value of \fBT_INFINITE\fR (-1) specifies that
115 there is no limit on the size (in octets) of an ETSDU; and a value of
116 \fBT_INVALID\fR (-2) specifies that the transfer of expedited data is not
117 supported by the transport provider. Note that the semantics of expedited data
118 may be quite different for different transport providers.
119 .RE
121 .sp
122 .ne 2
123 .na
124 \fB\fIconnect\fR\fR
125 .ad
126 .RS 12n
127 A value greater than zero specifies the maximum number of octets that may be
128 associated with connection establishment functions and a value of
129 \fBT_INVALID\fR (-2) specifies that the transport provider does not allow data
130 to be sent with connection establishment functions.
131 .RE
133 .sp
134 .ne 2
135 .na
136 \fB\fIdiscon\fR\fR
137 .ad
138 .RS 12n
139 If the \fBT_ORDRELDATA\fR bit in flags is clear, a value greater than zero
140 specifies the maximum number of octets that may be associated with the
141 \fBt_snddis\fR(3NSL) and \fBt_rcvdis\fR(3NSL) functions, and a value of
142 \fBT_INVALID\fR (-2) specifies that the transport provider does not allow data
143 to be sent with the abortive release functions. If the \fBT_ORDRELDATA\fR bit
144 is set in flags, a value greater than zero specifies the maximum number of
145 octets that may be associated with the \fBt_sndreldata()\fR,
146 \fBt_rcvreldata()\fR, \fBt_snddis\fR(3NSL) and \fBt_rcvdis\fR(3NSL) functions.
147 .RE
149 .sp
150 .ne 2
151 .na
152 \fB\fIservtype\fR\fR
153 .ad
154 .RS 12n
155 This field specifies the service type supported by the transport provider, as
156 described below.
157 .RE
159 .sp
160 .ne 2
161 .na
162 \fB\fIflags\fR\fR
163 .ad
164 .RS 12n
165 This is a bit field used to specify other information about the communications
166 provider. If the \fBT_ORDRELDATA\fR bit is set, the communications provider
167 supports sending user data with an orderly release. If the \fBT_SENDZERO\fR
168 bit is set in flags, this indicates that the underlying transport provider
169 supports the sending of zero-length TSDUs.
170 .RE
172 .sp
173 .LP
174 If a transport user is concerned with protocol independence, the above sizes
175 may be accessed to determine how large the buffers must be to hold each piece
176 of information. Alternatively, the \fBt_alloc\fR(3NSL) function may be used to
177 allocate these buffers. An error will result if a transport user exceeds the
178 allowed data size on any function. The value of each field may change as a
179 result of protocol option negotiation during connection establishment (the
180 \fBt_optmgmt\fR(3NSL) call has no effect on the values returned by
181 \fBt_getinfo()\fR\|). These values will only change from the values presented
182 to \fBt_open\fR(3NSL) after the endpoint enters the \fBT_DATAXFER\fR state.
183 .sp
184 .LP
185 The \fIservtype\fR field of \fIinfo\fR specifies one of the following values on
186 return:
187 .sp
188 .ne 2
189 .na
190 \fB\fBT_COTS\fR \fR
191 .ad
192 .RS 15n
193 The transport provider supports a connection-mode service but does not support
194 the optional orderly release facility.
195 .RE
197 .sp
198 .ne 2
199 .na
200 \fB\fBT_COTS_ORD\fR \fR
201 .ad
202 .RS 15n
203 The transport provider supports a connection-mode service with the optional
204 orderly release facility.
205 .RE
207 .sp
208 .ne 2
209 .na
210 \fB\fBT_CLTS\fR \fR
211 .ad
212 .RS 15n
213 The transport provider supports a connectionless-mode service. For this service
214 type, \fBt_open\fR(3NSL) will return \fBT_INVALID\fR (-1) for \fIetsdu\fR,
215 \fIconnect\fR and \fIdiscon\fR.
216 .RE
218 .SH RETURN VALUES
219 .sp
220 .LP
221 Upon successful completion, a value of \fB0\fR is returned. Otherwise, a
222 value of -1 is returned and \fBt_errno\fR is set to indicate an error.
223 .SH VALID STATES
224 .sp
225 .LP
226 ALL - apart from \fBT_UNINIT\fR.
227 .SH ERRORS
228 .sp
229 .LP
230 On failure, \fBt_errno\fR is set to one of the following:
231 .sp
232 .ne 2
233 .na
234 \fB\fBTBADF\fR\fR
235 .ad
236 .RS 11n
237 The specified file descriptor does not refer to a transport endpoint.
238 .RE
240 .sp
241 .ne 2
242 .na
243 \fB\fBTPROTO\fR\fR
244 .ad
245 .RS 11n
246 This error indicates that a communication problem has been detected between XTI
247 and the transport provider for which there is no other suitable XTI error
248 \fB(t_errno)\fR.
249 .RE
251 .sp
252 .ne 2
253 .na
254 \fB\fBTSYSERR\fR\fR
255 .ad
256 .RS 11n
257 A system error has occurred during execution of this function.
258 .RE
260 .SH TLI COMPATIBILITY
261 .sp
262 .LP
263 The \fBXTI\fR and \fBTLI\fR interface definitions have common names but use
264 different header files. This, and other semantic differences between the two
265 interfaces are described in the subsections below.
266 .SS "Interface Header"
267 .sp
268 .LP
269 The \fBXTI\fR interfaces use the header file, \fBxti.h\fR. \fBTLI\fR interfaces
270 should \fInot\fR use this header. They should use the header:
271 .sp
272 .in +2
273 .nf
274 #include <tiuser.h>
275 .fi
276 .in -2
278 .SS "Error Description Values"
279 .sp
280 .LP
281 The \fBt_errno\fR value \fBTPROTO\fR can be set by the \fBXTI\fR interface but
282 not by the \fBTLI\fR interface.
283 .SS "The t_info Structure"
284 .sp
285 .LP
286 For \fBTLI\fR , the \fBt_info\fR structure referenced by \fIinfo\fR lacks the
287 following structure member:
288 .sp
289 .in +2
290 .nf
291 t_scalar_t flags; /* other info about the transport provider */
292 .fi
293 .in -2
295 .sp
296 .LP
297 This member was added to \fBstruct\fR \fBt_info\fR in the \fBXTI\fR interfaces.
298 .sp
299 .LP
300 When a value of -1 is observed as the return value in various \fBt_info\fR
301 structure members, it signifies that the transport provider can handle an
302 infinite length buffer for a corresponding attribute, such as address data,
303 option data, \fBTSDU\fR (octet size), \fBETSDU\fR (octet size), connection
304 data, and disconnection data. The corresponding structure members are
305 \fBaddr\fR, \fBoptions\fR, \fBtsdu\fR, \fBestdu\fR, \fBconnect\fR, and
306 \fBdiscon\fR, respectively.
307 .SH ATTRIBUTES
308 .sp
309 .LP
310 See \fBattributes\fR(5) for descriptions of the following attributes:
311 .sp
313 .sp
314 .TS
315 box;
316 c | c
317 l | l .
318 ATTRIBUTE TYPE ATTRIBUTE VALUE
319 _
320 MT Level Safe
321 .TE
323 .SH SEE ALSO
324 .sp
325 .LP
326 \fBt_alloc\fR(3NSL), \fBt_open\fR(3NSL), \fBt_optmgmt\fR(3NSL),
327 \fBt_rcvdis\fR(3NSL), \fBt_snddis\fR(3NSL), \fBattributes\fR(5)