usr/src/man/man3nsl/t_rcvreldata.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_RCVRELDATA 3NSL "May 7, 1998"
  11 .SH NAME
  12 t_rcvreldata \- receive an orderly release indication or confirmation
  13 containing user data
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 #include <xti.h>
  18
  19
  20
  21 \fBint\fR \fBt_rcvreldata\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 receive an orderly release indication for the incoming
  28 direction of data transfer and to retrieve any user data sent with the release.
  29 The argument  \fIfd\fR identifies the local transport endpoint where the
  30 connection exists, and  \fIdiscon\fR points to a \fBt_discon\fR structure
  31 containing the 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 receipt of this indication, the user may not attempt to receive  more
  44 data by means of  \fBt_rcv\fR(3NSL) or  \fBt_rcvv\fR(3NSL) Such an attempt will
  45 fail with  \fIt_error\fR set to \fBTOUTSTATE\fR. However, the user may continue
  46 to send data over the connection if  \fBt_sndrel\fR(3NSL) or \fBt_sndreldata\fR
  47 \fB(3N)\fR has not been called by the user.
  48 .sp
  49 .LP
  50 The field  \fIreason\fR specifies the reason for the disconnection through a
  51 protocol-dependent  \fIreason code\fR, and  \fIudata\fR identifies any user
  52 data that was sent with the disconnection; the field  \fIsequence\fR is not
  53 used.
  54 .sp
  55 .LP
  56 If a user does not care if there is incoming data and does not need to know the
  57 value of  \fIreason\fR, \fIdiscon\fR may be a null pointer, and any user data
  58 associated with the disconnection will be discarded.
  59 .sp
  60 .LP
  61 If  \fIdiscon\(->udata.maxlen\fR is greater than zero and less than the length
  62 of the value,  \fBt_rcvreldata()\fR fails with  \fBt_errno\fR set to
  63 \fBTBUFOVFLW\fR.
  64 .sp
  65 .LP
  66 This function is an optional service of the transport provider, only supported
  67 by providers of service type \fBT_COTS_ORD.\fR The flag  \fBT_ORDRELDATA\fR in
  68 the  \fIinfo\(->flag\fR field returned by  \fBt_open\fR(3NSL) or
  69 \fBt_getinfo\fR(3NSL) indicates that the provider supports orderly release user
  70 data; when the flag is not set, this function behaves like \fBt_rcvrel\fR(3NSL)
  71 and no user data is returned.
  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 value
  79 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_OUTREL\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\fBTBADF\fR\fR
  92 .ad
  93 .RS 15n
  94 The specified file descriptor does not refer to a transport endpoint.
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fBTBUFOVFLW\fR\fR
 101 .ad
 102 .RS 15n
 103 The number of bytes allocated for incoming data (maxlen) is greater than
 104 \fB0\fR but not sufficient to store the data, and the disconnection information
 105 to be returned in  \fIdiscon\fR will be discarded. The provider state, as seen
 106 by the user, will be changed as if the data was successfully retrieved.
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fBTLOOK\fR\fR
 113 .ad
 114 .RS 15n
 115 An asynchronous event has occurred on this transport endpoint and requires
 116 immediate attention.
 117 .RE
 118
 119 .sp
 120 .ne 2
 121 .na
 122 \fB\fBTNOREL\fR\fR
 123 .ad
 124 .RS 15n
 125 No orderly release indication currently exists on the specified transport
 126 endpoint.
 127 .RE
 128
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fBTNOTSUPPORT\fR\fR
 133 .ad
 134 .RS 15n
 135 Orderly release is not supported by the underlying transport provider.
 136 .RE
 137
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fBTOUTSTATE\fR\fR
 142 .ad
 143 .RS 15n
 144 The communications endpoint referenced by \fIfd\fR is not in one of the states
 145 in which a call to this function is valid.
 146 .RE
 147
 148 .sp
 149 .ne 2
 150 .na
 151 \fB\fBTPROTO\fR\fR
 152 .ad
 153 .RS 15n
 154 This error indicates that a communication problem has been detected between XTI
 155 and the transport provider for which there is no other suitable XTI error
 156 \fB(t_errno)\fR.
 157 .RE
 158
 159 .sp
 160 .ne 2
 161 .na
 162 \fB\fBTSYSERR\fR\fR
 163 .ad
 164 .RS 15n
 165 A system error has occurred during execution of this function.
 166 .RE
 167
 168 .SH TLI COMPATIBILITY
 169 .sp
 170 .LP
 171 In the \fBTLI\fR interface definition, no counterpart of this routine was
 172 defined.
 173 .SH ATTRIBUTES
 174 .sp
 175 .LP
 176 See \fBattributes\fR(5)  for descriptions of the following attributes:
 177 .sp
 178
 179 .sp
 180 .TS
 181 box;
 182 c | c
 183 l | l .
 184 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 185 _
 186 MT Level        Safe
 187 .TE
 188
 189 .SH SEE ALSO
 190 .sp
 191 .LP
 192 \fBt_getinfo\fR(3NSL), \fBt_open\fR(3NSL), \fBt_sndreldata\fR(3NSL),
 193 \fBt_rcvrel\fR(3NSL), \fBt_sndrel\fR(3NSL), \fBattributes\fR(5)
 194 .SH NOTES
 195 .sp
 196 .LP
 197 The interfaces \fBt_sndreldata\fR(3NSL) and \fBt_rcvreldata()\fR are only for
 198 use with a specific transport called "minimal OSI," which is not available on
 199 the Solaris platform. These interfaces are not available for use in conjunction
 200 with Internet Transports (\fBTCP\fR or \fBUDP\fR).