8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man3nsl / t_close.3nsl
blobc8b17de412f4d6ccf58213111bc8a6afdeda1c23
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_CLOSE 3NSL "May 7, 1998"
11 .SH NAME
12 t_close \- close a transport endpoint
13 .SH SYNOPSIS
14 .LP
15 .nf
16 #include <xti.h>
21 \fBint\fR \fBt_close\fR(\fBint\fR \fIfd\fR);
22 .fi
24 .SH DESCRIPTION
25 .sp
26 .LP
27 This routine is part of the \fBXTI\fR interfaces which evolved from the
28 \fBTLI\fR interfaces. \fBXTI\fR represents the future evolution of these
29 interfaces. However, \fBTLI\fR interfaces are supported for compatibility. When
30 using a \fBTLI\fR routine that has the same name as an \fBXTI\fR routine, the
31 \fBtiuser.h\fR header file must be used.  Refer to the  \fBTLI\fR
32 \fBCOMPATIBILITY\fR section for a description of differences between the two
33 interfaces.
34 .sp
35 .LP
36 The \fBt_close()\fR function informs the transport provider that the user is
37 finished with the transport endpoint specified by \fIfd\fR, and frees any local
38 library resources associated with the endpoint. In addition, \fBt_close()\fR
39 closes the file associated with the transport endpoint.
40 .sp
41 .LP
42 The function \fBt_close()\fR should be called from the \fBT_UNBND\fR state. See
43 \fBt_getstate\fR(3NSL). However, this function does not check state
44 information, so it may be called from any state to close a transport endpoint.
45 If this occurs, the local library resources associated with the endpoint will
46 be freed automatically.  In addition, \fBclose\fR(2) will be issued for that
47 file descriptor; if there are no other descriptors in this process or in
48 another process which references the communication endpoint, any connection
49 that may be associated with that endpoint is broken. The connection may be
50 terminated in an orderly or abortive manner.
51 .sp
52 .LP
53 A \fBt_close()\fR issued on a connection endpoint may cause data previously
54 sent, or data not yet received, to be lost. It is the responsibility of the
55 transport user to ensure that data is received by the remote peer.
56 .SH RETURN VALUES
57 .sp
58 .LP
59 Upon successful completion, a value of  \fB0\fR \fBis\fR returned.  Otherwise,
60 a value of  -1 \fBis\fR \fBreturned\fR \fBand\fR \fBt_errno\fR is set to
61 indicate an error.
62 .SH VALID STATES
63 .sp
64 .LP
65 \fBT_UNBND\fR
66 .SH ERRORS
67 .sp
68 .LP
69 On failure, \fBt_errno\fR is set to the following:
70 .sp
71 .ne 2
72 .na
73 \fB\fBTBADF\fR\fR
74 .ad
75 .RS 11n
76 The specified file descriptor does not refer to a transport endpoint.
77 .RE
79 .sp
80 .ne 2
81 .na
82 \fB\fBTPROTO\fR\fR
83 .ad
84 .RS 11n
85 This error indicates that a communication problem has been detected between XTI
86 and the transport provider for which there is no other suitable XTI error
87 \fB(t_errno)\fR.
88 .RE
90 .sp
91 .ne 2
92 .na
93 \fB\fBTSYSERR\fR\fR
94 .ad
95 .RS 11n
96 A system error has occurred during execution of this function.
97 .RE
99 .SH TLI COMPATIBILITY
102 The \fBXTI\fR and \fBTLI\fR interface definitions have common names but use
103 different header files. This, and other semantic differences between the two
104 interfaces are described in the subsections below.
105 .SS "Interface Header"
108 The \fBXTI\fR interfaces use the header file, \fBxti.h\fR. \fBTLI\fR interfaces
109 should \fInot\fR use this header.  They should use the header:
112 \fB#include\fR \fB<tiuser.h>\fR
113 .SS "Error Description Values"
116 The \fBt_errno\fR value that can be set by the \fBXTI\fR interface and cannot
117 be set by the \fBTLI\fR interface is:
119 .ne 2
121 \fB\fBTPROTO\fR \fR
123 .RS 11n
127 .SH ATTRIBUTES
130 See \fBattributes\fR(5)  for descriptions of the following attributes:
135 box;
136 c | c
137 l | l .
138 ATTRIBUTE TYPE  ATTRIBUTE VALUE
140 MT Level        Safe
143 .SH SEE ALSO
146 \fBclose\fR(2), \fBt_getstate\fR(3NSL), \fBt_open\fR(3NSL),
147 \fBt_unbind\fR(3NSL), \fBattributes\fR(5)