usr/src/man/man3nsl/t_sndrel.3nsl

   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_SNDREL 3NSL "May 7, 1998"
  11 .SH NAME
  12 t_sndrel \- initiate an orderly release
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <xti.h>
  17
  18
  19
  20 \fBint\fR \fBt_sndrel\fR(\fBint\fR \fIfd\fR);
  21 .fi
  22
  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 For transport providers of type  \fBT_COTS_ORD,\fR this function is used to
  36 initiate an orderly release of the outgoing direction of data transfer and
  37 indicates to the transport provider that the transport user has no more data to
  38 send. The argument \fIfd\fR identifies the local transport endpoint where the
  39 connection exists. After calling \fBt_sndrel()\fR, the user may not send any
  40 more data over the connection. However, a user may continue to receive data if
  41 an orderly release indication has not been received. For transport providers of
  42 types other than  \fBT_COTS_ORD,\fR this function fails with error
  43 \fBTNOTSUPPORT\fR.
  44 .SH RETURN VALUES
  45 .sp
  46 .LP
  47 Upon successful completion, a value of  \fB0\fR is returned.  Otherwise, a
  48 value of  -1 is \fBreturned\fR and \fBt_errno\fR is set to indicate an error.
  49 .SH VALID STATES
  50 .sp
  51 .LP
  52 \fBT_DATAXFER\fR, \fBT_INREL\fR.
  53 .SH ERRORS
  54 .sp
  55 .LP
  56 On failure, \fBt_errno\fR is set to one of the following:
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fBTBADF\fR\fR
  61 .ad
  62 .RS 15n
  63 The specified file descriptor does not refer to a transport endpoint.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBTFLOW\fR\fR
  70 .ad
  71 .RS 15n
  72 \fBO_NONBLOCK\fR was set, but the flow control mechanism prevented the
  73 transport provider from accepting the function at this time.
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBTLOOK\fR\fR
  80 .ad
  81 .RS 15n
  82 An asynchronous event has occurred on this transport endpoint and requires
  83 immediate attention.
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fBTNOTSUPPORT\fR\fR
  90 .ad
  91 .RS 15n
  92 This function is not supported by the underlying transport provider.
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBTOUTSTATE\fR\fR
  99 .ad
 100 .RS 15n
 101 The communications endpoint referenced by  \fIfd\fR is not in one of the states
 102 in which a call to this function is valid.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBTPROTO\fR\fR
 109 .ad
 110 .RS 15n
 111 This error indicates that a communication problem has been detected between XTI
 112 and the transport provider for which there is no other suitable XTI error
 113 \fB(t_errno)\fR.
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fBTSYSERR\fR\fR
 120 .ad
 121 .RS 15n
 122 A system error has occurred during execution of this function.
 123 .RE
 124
 125 .SH TLI COMPATIBILITY
 126 .sp
 127 .LP
 128 The \fBXTI\fR and \fBTLI\fR interface definitions have common names but use
 129 different header files. This, and other semantic differences between the two
 130 interfaces are described in the subsections below.
 131 .SS "Interface Header"
 132 .sp
 133 .LP
 134 The \fBXTI\fR interfaces use the header file, \fBxti.h\fR. \fBTLI\fR interfaces
 135 should \fInot\fR use this header.  They should use the header:
 136 .br
 137 .in +2
 138 #include <tiuser.h>
 139 .in -2
 140 .SS "Error Description Values"
 141 .sp
 142 .LP
 143 The \fBt_errno\fR values that can be set by the \fBXTI\fR interface and cannot
 144 be set by the \fBTLI\fR interface are:
 145 .br
 146 .in +2
 147 \fBTPROTO\fR
 148 .in -2
 149 .br
 150 .in +2
 151 \fBTLOOK\fR
 152 .in -2
 153 .br
 154 .in +2
 155 \fBTOUTSTATE\fR
 156 .in -2
 157 .SS "Notes"
 158 .sp
 159 .LP
 160 Whenever this function fails with \fBt_error\fR set to \fBTFLOW,\fR
 161 \fBO_NONBLOCK\fR must have been set.
 162 .SH ATTRIBUTES
 163 .sp
 164 .LP
 165 See \fBattributes\fR(5)  for descriptions of the following attributes:
 166 .sp
 167
 168 .sp
 169 .TS
 170 box;
 171 c | c
 172 l | l .
 173 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 174 _
 175 MT Level        Safe
 176 .TE
 177
 178 .SH SEE ALSO
 179 .sp
 180 .LP
 181 \fBt_error\fR(3NSL), \fBt_getinfo\fR(3NSL), \fBt_open\fR(3NSL),
 182 \fBt_rcvrel\fR(3NSL), \fBattributes\fR(5)