usr/src/man/man3nsl/t_sndreldata.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_SNDRELDATA 3NSL "May 7, 1998"
  11 .SH NAME
  12 t_sndreldata \- initiate or respond to an orderly release with user data
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <xti.h>
  17
  18
  19
  20
  21 \fBint\fR \fBt_sndreldata\fR(\fBint\fR \fIfd\fR, \fBstruct t_discon *\fR\fIdiscon\fR);
  22 .fi
  23
  24 .SH DESCRIPTION
  25 .sp
  26 .LP
  27 This function is used to initiate an orderly release of the outgoing direction
  28 of data transfer and to send user data with the release.  The argument
  29 \fIfd\fR identifies the local transport endpoint where the connection exists,
  30 and  \fIdiscon\fR points to a  \fB t_discon\fR structure containing the
  31 following members:
  32 .sp
  33 .in +2
  34 .nf
  35 struct netbuf udata;
  36 int reason;
  37 int sequence;
  38 .fi
  39 .in -2
  40
  41 .sp
  42 .LP
  43 After calling  \fBt_sndreldata()\fR, the user may not send any more data over
  44 the connection.  However, a user may continue to receive data if an orderly
  45 release indication has not been received.
  46 .sp
  47 .LP
  48 The field  \fIreason\fR specifies the reason for the disconnection through a
  49 protocol-dependent  \fIreason code\fR, and  \fIudata\fR identifies any user
  50 data that is sent with the disconnection; the field  \fIsequence\fR is not
  51 used.
  52 .sp
  53 .LP
  54 The  \fIudata\fR structure specifies the user data to be sent to the remote
  55 user.  The amount of user data must not exceed the limits supported by the
  56 transport provider, as returned in the  \fIdiscon\fR field of the  \fIinfo\fR
  57 argument of \fBt_open\fR(3NSL) or  \fBt_getinfo\fR(3NSL). If the  \fIlen\fR
  58 field of  \fIudata\fR is zero or if the provider did not return
  59 \fBT_ORDRELDATA\fR in the  \fBt_open\fR(3NSL) flags, no data will be sent to
  60 the remote user.
  61 .sp
  62 .LP
  63 If a user does not wish to send data and reason code to the remote user, the
  64 value of  \fIdiscon\fR may be a null pointer.
  65 .sp
  66 .LP
  67 This function is an optional service of the transport provider, only supported
  68 by providers of service type \fBT_COTS_ORD.\fR The flag  \fBT_ORDRELDATA\fR in
  69 the  \fIinfo\(->flag\fR field returned by  \fBt_open\fR(3NSL) or
  70 \fBt_getinfo\fR(3NSL) indicates that the provider supports orderly release user
  71 data.
  72 .sp
  73 .LP
  74 This function may not be available on all systems.
  75 .SH RETURN VALUES
  76 .sp
  77 .LP
  78 Upon successful completion, a value of  \fB0\fR is returned.  Otherwise, a
  79 value of  -1 is returned and  \fBt_errno\fR is set to indicate an error.
  80 .SH VALID STATES
  81 .sp
  82 .LP
  83 \fBT_DATAXFER\fR, \fBT_INREL\fR.
  84 .SH ERRORS
  85 .sp
  86 .LP
  87 On failure,  \fBt_errno\fR is set to one of the following:
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBTBADDATA\fR\fR
  92 .ad
  93 .RS 15n
  94 The amount of user data specified was not within the bounds allowed by the
  95 transport provider, or user data was supplied and the provider did not return
  96 \fBT_ORDRELDATA\fR in the  \fBt_open\fR(3NSL) flags.
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fBTBADF\fR\fR
 103 .ad
 104 .RS 15n
 105 The specified file descriptor does not refer to a transport endpoint.
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fBTFLOW\fR\fR
 112 .ad
 113 .RS 15n
 114 \fBO_NONBLOCK\fR was set, but the flow control mechanism prevented the
 115 transport provider from accepting the function at this time.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fBTLOOK\fR\fR
 122 .ad
 123 .RS 15n
 124 An asynchronous event has occurred on this transport endpoint and requires
 125 immediate attention.
 126 .RE
 127
 128 .sp
 129 .ne 2
 130 .na
 131 \fB\fBTNOTSUPPORT\fR\fR
 132 .ad
 133 .RS 15n
 134 Orderly release is not supported by the underlying transport provider.
 135 .RE
 136
 137 .sp
 138 .ne 2
 139 .na
 140 \fB\fBTOUTSTATE\fR\fR
 141 .ad
 142 .RS 15n
 143 The communications endpoint referenced by \fIfd\fR is not in one of the states
 144 in which a call to this function is valid.
 145 .RE
 146
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fBTPROTO\fR\fR
 151 .ad
 152 .RS 15n
 153 This error indicates that a communication problem has been detected between XTI
 154 and the transport provider for which there is no other suitable XTI error
 155 \fB(t_errno)\fR.
 156 .RE
 157
 158 .sp
 159 .ne 2
 160 .na
 161 \fB\fBTSYSERR\fR\fR
 162 .ad
 163 .RS 15n
 164 A system error has occurred during execution of this function.
 165 .RE
 166
 167 .SH TLI COMPATIBILITY
 168 .sp
 169 .LP
 170 In the \fBTLI\fR interface definition, no counterpart of this routine was
 171 defined.
 172 .SH ATTRIBUTES
 173 .sp
 174 .LP
 175 See \fBattributes\fR(5)  for descriptions of the following attributes:
 176 .sp
 177
 178 .sp
 179 .TS
 180 box;
 181 c | c
 182 l | l .
 183 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 184 _
 185 MT Level        Safe
 186 .TE
 187
 188 .SH SEE ALSO
 189 .sp
 190 .LP
 191 \fBt_getinfo\fR(3NSL), \fBt_open\fR(3NSL), \fBt_rcvrel\fR(3NSL),
 192 \fBt_rcvreldata\fR(3NSL), \fBt_sndrel\fR(3NSL), \fBattributes\fR(5)
 193 .SH NOTES
 194 .sp
 195 .LP
 196 The interfaces \fBt_sndreldata()\fR and \fBt_rcvreldata\fR(3NSL) are only for
 197 use with a specific transport called "minimal OSI," which is not available on
 198 the Solaris platform. These interfaces are not available for use in conjunction
 199 with Internet Transports (\fBTCP\fR or \fBUDP\fR).