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

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Portions Copyright 1989 AT&T
  44 .\" Copyright 1994, The X/Open Company Ltd.  All Rights Reserved.
  45 .\" Portions Copyright (c) 1998, Sun Microsystems, Inc.  All Rights Reserved.
  46 .\"
  47 .TH T_SNDREL 3NSL "May 7, 1998"
  48 .SH NAME
  49 t_sndrel \- initiate an orderly release
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <xti.h>
  54
  55
  56
  57 \fBint\fR \fBt_sndrel\fR(\fBint\fR \fIfd\fR);
  58 .fi
  59
  60 .SH DESCRIPTION
  61 .sp
  62 .LP
  63 This routine is part of the \fBXTI\fR interfaces which evolved from the
  64 \fBTLI\fR interfaces. \fBXTI\fR represents the future evolution of these
  65 interfaces. However, \fBTLI\fR interfaces are supported for compatibility. When
  66 using a \fBTLI\fR routine that has the same name as an \fBXTI\fR routine, the
  67 \fBtiuser.h\fR header file must be used.  Refer to the  \fBTLI\fR
  68 \fBCOMPATIBILITY\fR section for a description of differences between the two
  69 interfaces.
  70 .sp
  71 .LP
  72 For transport providers of type  \fBT_COTS_ORD,\fR this function is used to
  73 initiate an orderly release of the outgoing direction of data transfer and
  74 indicates to the transport provider that the transport user has no more data to
  75 send. The argument \fIfd\fR identifies the local transport endpoint where the
  76 connection exists. After calling \fBt_sndrel()\fR, the user may not send any
  77 more data over the connection. However, a user may continue to receive data if
  78 an orderly release indication has not been received. For transport providers of
  79 types other than  \fBT_COTS_ORD,\fR this function fails with error
  80 \fBTNOTSUPPORT\fR.
  81 .SH RETURN VALUES
  82 .sp
  83 .LP
  84 Upon successful completion, a value of  \fB0\fR is returned.  Otherwise, a
  85 value of  -1 is \fBreturned\fR and \fBt_errno\fR is set to indicate an error.
  86 .SH VALID STATES
  87 .sp
  88 .LP
  89 \fBT_DATAXFER\fR, \fBT_INREL\fR.
  90 .SH ERRORS
  91 .sp
  92 .LP
  93 On failure, \fBt_errno\fR is set to one of the following:
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fBTBADF\fR\fR
  98 .ad
  99 .RS 15n
 100 The specified file descriptor does not refer to a transport endpoint.
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBTFLOW\fR\fR
 107 .ad
 108 .RS 15n
 109 \fBO_NONBLOCK\fR was set, but the flow control mechanism prevented the
 110 transport provider from accepting the function at this time.
 111 .RE
 112
 113 .sp
 114 .ne 2
 115 .na
 116 \fB\fBTLOOK\fR\fR
 117 .ad
 118 .RS 15n
 119 An asynchronous event has occurred on this transport endpoint and requires
 120 immediate attention.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fBTNOTSUPPORT\fR\fR
 127 .ad
 128 .RS 15n
 129 This function is not supported by the underlying transport provider.
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fB\fBTOUTSTATE\fR\fR
 136 .ad
 137 .RS 15n
 138 The communications endpoint referenced by  \fIfd\fR is not in one of the states
 139 in which a call to this function is valid.
 140 .RE
 141
 142 .sp
 143 .ne 2
 144 .na
 145 \fB\fBTPROTO\fR\fR
 146 .ad
 147 .RS 15n
 148 This error indicates that a communication problem has been detected between XTI
 149 and the transport provider for which there is no other suitable XTI error
 150 \fB(t_errno)\fR.
 151 .RE
 152
 153 .sp
 154 .ne 2
 155 .na
 156 \fB\fBTSYSERR\fR\fR
 157 .ad
 158 .RS 15n
 159 A system error has occurred during execution of this function.
 160 .RE
 161
 162 .SH TLI COMPATIBILITY
 163 .sp
 164 .LP
 165 The \fBXTI\fR and \fBTLI\fR interface definitions have common names but use
 166 different header files. This, and other semantic differences between the two
 167 interfaces are described in the subsections below.
 168 .SS "Interface Header"
 169 .sp
 170 .LP
 171 The \fBXTI\fR interfaces use the header file, \fBxti.h\fR. \fBTLI\fR interfaces
 172 should \fInot\fR use this header.  They should use the header:
 173 .br
 174 .in +2
 175 #include <tiuser.h>
 176 .in -2
 177 .SS "Error Description Values"
 178 .sp
 179 .LP
 180 The \fBt_errno\fR values that can be set by the \fBXTI\fR interface and cannot
 181 be set by the \fBTLI\fR interface are:
 182 .br
 183 .in +2
 184 \fBTPROTO\fR
 185 .in -2
 186 .br
 187 .in +2
 188 \fBTLOOK\fR
 189 .in -2
 190 .br
 191 .in +2
 192 \fBTOUTSTATE\fR
 193 .in -2
 194 .SS "Notes"
 195 .sp
 196 .LP
 197 Whenever this function fails with \fBt_error\fR set to \fBTFLOW,\fR
 198 \fBO_NONBLOCK\fR must have been set.
 199 .SH ATTRIBUTES
 200 .sp
 201 .LP
 202 See \fBattributes\fR(5)  for descriptions of the following attributes:
 203 .sp
 204
 205 .sp
 206 .TS
 207 box;
 208 c | c
 209 l | l .
 210 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 211 _
 212 MT Level        Safe
 213 .TE
 214
 215 .SH SEE ALSO
 216 .sp
 217 .LP
 218 \fBt_error\fR(3NSL), \fBt_getinfo\fR(3NSL), \fBt_open\fR(3NSL),
 219 \fBt_rcvrel\fR(3NSL), \fBattributes\fR(5)