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

   1 '\" te
   2 .\" Copyright 1994, The X/Open Company Ltd.  All Rights Reserved.
   3 .\" Portions Copyright 1989 AT&T
   4 .\" Portions Copyright (C) 2007, Sun Microsystems, Inc. All Rights Reserved
   5 .\" 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
   6 .\" http://www.opengroup.org/bookstore/.
   7 .\" 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.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" 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.
  10 .\" 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.
  11 .\" 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]
  12 .TH T_RCV 3NSL "Aug 24, 2007"
  13 .SH NAME
  14 t_rcv \- receive data or expedited data sent over a connection
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 #include <xti.h>
  19
  20 \fBint\fR \fBt_rcv\fR(\fBint\fR \fIfd\fR, \fBvoid *\fR\fIbuf\fR, \fBunsigned int\fR \fInbytes\fR, \fBint *\fR\fIflags\fR);
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 This function 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 function that has the same name as an \fBXTI\fR function, 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 This function receives either normal or expedited data. The argument \fIfd\fR
  36 identifies the local transport endpoint through which data will arrive,
  37 \fIbuf\fR points to a receive buffer where user data will be placed, and
  38 \fInbytes\fR specifies the size of the receive buffer. The argument \fIflags\fR
  39 may be set on return from \fBt_rcv()\fR and specifies optional flags as
  40 described below.
  41 .sp
  42 .LP
  43 By default, \fBt_rcv()\fR operates in synchronous mode and will wait for data
  44 to arrive if none is currently available. However, if \fBO_NONBLOCK\fR is set
  45 by means of \fBt_open\fR(3NSL) or \fBfcntl\fR(2), \fBt_rcv()\fR will execute in
  46 asynchronous mode and will fail if no data is available. See \fBTNODATA\fR
  47 below.
  48 .sp
  49 .LP
  50 On return from the call, if  \fBT_MORE\fR is set in \fIflags\fR, this indicates
  51 that there is more data, and the current transport service data unit (TSDU) or
  52 expedited transport service data unit (ETSDU) must be received in multiple
  53 \fBt_rcv()\fR calls. In the asynchronous mode, or under unusual conditions (for
  54 example, the arrival of a signal or  \fBT_EXDATA\fR event),  the  \fBT_MORE\fR
  55 flag may be set on return from the \fBt_rcv()\fR call even when the number of
  56 bytes received is less than the size of the receive buffer specified. Each
  57 \fBt_rcv()\fR with the  \fBT_MORE\fR flag set indicates that another
  58 \fBt_rcv()\fR must follow to get more data for the current TSDU. The end of the
  59 TSDU is identified by the return of a \fBt_rcv()\fR call with the  \fBT_MORE\fR
  60 flag not set. If the transport provider does not support the concept of a TSDU
  61 as indicated in the \fIinfo\fR argument on return from \fBt_open\fR(3NSL) or
  62 \fBt_getinfo\fR(3NSL), the  \fBT_MORE\fR flag is not meaningful and should be
  63 ignored.  If \fInbytes\fR is greater than zero on the call to \fBt_rcv()\fR,
  64 \fBt_rcv()\fR will return  \fB0\fR only if the end of a TSDU is being returned
  65 to the user.
  66 .sp
  67 .LP
  68 On return, the data is expedited if  \fBT_EXPEDITED\fR is set in flags.  If
  69 \fBT_MORE\fR is also set, it indicates that the number of expedited bytes
  70 exceeded nbytes, a signal has interrupted the  call, or that an entire ETSDU
  71 was not available (only for transport protocols that support fragmentation of
  72 ETSDUs).  The rest of the ETSDU will be returned by subsequent calls to
  73 \fBt_rcv()\fR which will return with  \fBT_EXPEDITED\fR set in flags. The end
  74 of the ETSDU is identified by the return of a  \fBt_rcv()\fR call with
  75 \fBT_EXPEDITED\fR set and  \fBT_MORE\fR cleared.  If the entire ETSDU is not
  76 available it is possible for normal data fragments to be returned between the
  77 initial and final fragments of an ETSDU.
  78 .sp
  79 .LP
  80 If a signal arrives, \fBt_rcv()\fR returns, giving the user any data currently
  81 available.  If no data is available,  \fBt_rcv()\fR returns  -1, sets
  82 \fBt_errno\fR to \fBTSYSERR\fR and  \fBerrno\fR to \fBEINTR\fR. If some data is
  83 available,  \fBt_rcv()\fR returns the number of bytes received and
  84 \fBT_MORE\fR is set in flags.
  85 .sp
  86 .LP
  87 In synchronous mode, the only way for the user to be notified of the arrival of
  88 normal or expedited data is to issue this function or check for the
  89 \fBT_DATA\fR or  \fBT_EXDATA\fR events using the \fBt_look\fR(3NSL) function.
  90 Additionally, the process can arrange to be notified by means of the EM
  91 interface.
  92 .SH RETURN VALUES
  93 .sp
  94 .LP
  95 On successful completion, \fBt_rcv()\fR returns the number of bytes received.
  96 Otherwise, it returns  \fB\(mi1\fR on failure and \fBt_errno\fR is set to
  97 indicate the error.
  98 .SH VALID STATES
  99 .sp
 100 .LP
 101 \fBT_DATAXFER\fR, \fBT_OUTREL\fR.
 102 .SH ERRORS
 103 .sp
 104 .LP
 105 On failure, \fBt_errno\fR is set to one of the following:
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fBTBADF\fR\fR
 110 .ad
 111 .RS 15n
 112 The specified file descriptor does not refer to a transport endpoint.
 113 .RE
 114
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fBTLOOK\fR\fR
 119 .ad
 120 .RS 15n
 121 An asynchronous event has occurred on this transport endpoint and requires
 122 immediate attention.
 123 .RE
 124
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fBTNODATA\fR\fR
 129 .ad
 130 .RS 15n
 131 \fBO_NONBLOCK\fR was set, but no data is currently available from the transport
 132 provider.
 133 .RE
 134
 135 .sp
 136 .ne 2
 137 .na
 138 \fB\fBTNOTSUPPORT\fR\fR
 139 .ad
 140 .RS 15n
 141 This function is not supported by the underlying transport provider.
 142 .RE
 143
 144 .sp
 145 .ne 2
 146 .na
 147 \fB\fBTOUTSTATE\fR\fR
 148 .ad
 149 .RS 15n
 150 The communications endpoint referenced by \fIfd\fR is not in one of the states
 151 in which a call to this function is valid.
 152 .RE
 153
 154 .sp
 155 .ne 2
 156 .na
 157 \fB\fBTPROTO\fR\fR
 158 .ad
 159 .RS 15n
 160 This error indicates that a communication problem has been detected between XTI
 161 and the transport provider for which there is no other suitable XTI error
 162 \fB(t_errno)\fR.
 163 .RE
 164
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fBTSYSERR\fR\fR
 169 .ad
 170 .RS 15n
 171 A system error has occurred during execution of this function.
 172 .RE
 173
 174 .SH TLI COMPATIBILITY
 175 .sp
 176 .LP
 177 The \fBXTI\fR and \fBTLI\fR interface definitions have common names but use
 178 different header files. This, and other semantic differences between the two
 179 interfaces are described in the subsections below.
 180 .SS "Interface Header"
 181 .sp
 182 .LP
 183 The \fBXTI\fR interfaces use the header file, \fBxti.h\fR. \fBTLI\fR interfaces
 184 should \fInot\fR use this header.  They should use the header:
 185 .br
 186 .in +2
 187 #include <tiuser.h>
 188 .in -2
 189 .SS "Error Description Values"
 190 .sp
 191 .LP
 192 The \fBt_errno\fR value that can be set by the \fBXTI\fR interface and cannot
 193 be set by the \fBTLI\fR interface is:
 194 .br
 195 .in +2
 196 \fBTPROTO\fR
 197 .in -2
 198 .SH ATTRIBUTES
 199 .sp
 200 .LP
 201 See \fBattributes\fR(5)  for descriptions of the following attributes:
 202 .sp
 203
 204 .sp
 205 .TS
 206 box;
 207 c | c
 208 l | l .
 209 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 210 _
 211 Interface Stability     Committed
 212 _
 213 MT-Level        Safe
 214 _
 215 Standard        See \fBstandards\fR(5).
 216 .TE
 217
 218 .SH SEE ALSO
 219 .sp
 220 .LP
 221 \fBfcntl\fR(2), \fBt_getinfo\fR(3NSL), \fBt_look\fR(3NSL), \fBt_open\fR(3NSL),
 222 \fBt_snd\fR(3NSL), \fBattributes\fR(5), \fBstandards\fR(5)