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

   1 '\" te
   2 .\" Copyright 2014 Nexenta Systems, Inc.  All rights reserved.
   3 .\"  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
   4 .\" 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
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\" 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.
   7 .\"  This notice shall appear on any product containing this material.
   8 .\" 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.
   9 .\" 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.
  10 .\" 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]
  11 .TH T_RCVUDATA 3NSL "Oct 22, 2014"
  12 .SH NAME
  13 t_rcvudata \- receive a data unit
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 #include <xti.h>
  18
  19
  20
  21 \fBint\fR \fBt_rcvudata\fR(\fBint\fR \fIfd\fR, \fBstruct t_unitdata *\fR\fIunitdata\fR, \fBint *\fR\fIflags\fR);
  22 .fi
  23
  24 .SH DESCRIPTION
  25 .sp
  26 .LP
  27 This routine is part of the \fBXTI\fR interfaces which evolved from the
  28 \fBTLI\fR interfaces. \fBXTI\fR represents the future evolution of these
  29 interfaces. However, \fBTLI\fR interfaces are supported for compatibility. When
  30 using a \fBTLI\fR routine that has the same name as an \fBXTI\fR routine, the
  31 \fBtiuser.h\fR header file must be used.  Refer to the  \fBTLI\fR
  32 \fBCOMPATIBILITY\fR section for a description of differences between the two
  33 interfaces.
  34 .sp
  35 .LP
  36 This function is used in connectionless-mode to receive a data unit from
  37 another transport user. The argument \fIfd\fR identifies the local transport
  38 endpoint through which data will be received, \fIunitdata\fR holds information
  39 associated with the received data unit, and \fIflags\fR is set on return to
  40 indicate that the complete data unit was not received. The argument
  41 \fIunitdata\fR points to a \fBt_unitdata\fR structure containing the following
  42 members:
  43 .sp
  44 .in +2
  45 .nf
  46 \fBstruct netbuf addr;
  47 struct netbuf opt;
  48 struct netbuf udata;\fR
  49 .fi
  50 .in -2
  51
  52 .sp
  53 .LP
  54 The \fImaxlen\fR field of \fIaddr\fR, \fIopt\fR and \fIudata\fR must be set
  55 before calling this function to indicate the maximum size of the buffer for
  56 each. If the  \fImaxlen\fR field of  \fIaddr\fR or  \fIopt\fR is set to zero,
  57 no information is returned in the  \fIbuf\fR field of this parameter.
  58 .sp
  59 .LP
  60 On return from this call, \fIaddr\fR specifies the protocol address of the
  61 sending user, \fIopt\fR identifies options that were associated with this data
  62 unit, and \fIudata\fR specifies the user data that was received.
  63 .sp
  64 .LP
  65 By default, \fBt_rcvudata()\fR operates in synchronous mode and will wait for a
  66 data unit to arrive if none is currently available. However, if
  67 \fBO_NONBLOCK\fR is set by means of  \fBt_open\fR(3NSL) or \fBfcntl\fR(2),
  68 \fBt_rcvudata()\fR will execute in asynchronous mode and will fail if no data
  69 units are available.
  70 .sp
  71 .LP
  72 If the buffer defined in the \fIudata\fR field of \fIunitdata\fR is not large
  73 enough to hold the current data unit, the buffer will be filled and
  74 \fBT_MORE\fR will be set in \fIflags\fR on return to indicate that another
  75 \fBt_rcvudata()\fR should be called to retrieve the rest of the data unit.
  76 Subsequent calls to \fBt_rcvudata()\fR will return zero for the length of the
  77 address and options until the full data unit has been received.
  78 .sp
  79 .LP
  80 If the call is interrupted, \fBt_rcvudata()\fR will return \fBEINTR\fR and no
  81 datagrams will have been removed from the endpoint.
  82 .SH RETURN VALUES
  83 .sp
  84 .LP
  85 Upon successful completion, a value of  \fB0\fR is returned.  Otherwise, a
  86 value of  \(mi1 is returned and \fBt_errno\fR is set to indicate an error.
  87 .SH VALID STATES
  88 .sp
  89 .LP
  90 \fBT_IDLE\fR.
  91 .SH ERRORS
  92 .sp
  93 .LP
  94 On failure, \fBt_errno\fR is set to one of the following:
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBTBADF\fR\fR
  99 .ad
 100 .RS 15n
 101 The specified file descriptor does not refer to a transport endpoint.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBTBUFOVFLW\fR\fR
 108 .ad
 109 .RS 15n
 110 The number of bytes allocated for the incoming protocol address or options
 111 \fI(maxlen)\fR is greater than  \fB0\fR but not sufficient to store the
 112 information. The unit data information to be returned in \fIunitdata\fR will be
 113 discarded.
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fBTLOOK\fR\fR
 120 .ad
 121 .RS 15n
 122 An asynchronous event has occurred on this transport endpoint and requires
 123 immediate attention.
 124 .RE
 125
 126 .sp
 127 .ne 2
 128 .na
 129 \fB\fBTNODATA\fR\fR
 130 .ad
 131 .RS 15n
 132 \fBO_NONBLOCK\fR was set, but no data units are currently available from the
 133 transport provider.
 134 .RE
 135
 136 .sp
 137 .ne 2
 138 .na
 139 \fB\fBTNOTSUPPORT\fR\fR
 140 .ad
 141 .RS 15n
 142 This function is not supported by the underlying transport provider.
 143 .RE
 144
 145 .sp
 146 .ne 2
 147 .na
 148 \fB\fBTOUTSTATE\fR\fR
 149 .ad
 150 .RS 15n
 151 The communications endpoint referenced by  \fIfd\fR is not in one of the states
 152 in which a call to this function is valid.
 153 .RE
 154
 155 .sp
 156 .ne 2
 157 .na
 158 \fB\fBTPROTO\fR\fR
 159 .ad
 160 .RS 15n
 161 This error indicates that a communication problem has been detected between XTI
 162 and the transport provider for which there is no other suitable XTI error
 163 \fB(t_errno)\fR.
 164 .RE
 165
 166 .sp
 167 .ne 2
 168 .na
 169 \fB\fBTSYSERR\fR\fR
 170 .ad
 171 .RS 15n
 172 A system error has occurred during execution of this function.
 173 .RE
 174
 175 .SH TLI COMPATIBILITY
 176 .sp
 177 .LP
 178 The \fBXTI\fR and \fBTLI\fR interface definitions have common names but use
 179 different header files. This, and other semantic differences between the two
 180 interfaces are described in the subsections below.
 181 .SS "Interface Header"
 182 .sp
 183 .LP
 184 The \fBXTI\fR interfaces use the header file, \fBxti.h\fR. \fBTLI\fR interfaces
 185 should \fInot\fR use this header.  They should use the header:
 186 .br
 187 .in +2
 188 #include <tiuser.h>
 189 .in -2
 190 .SS "Error Description Values"
 191 .sp
 192 .LP
 193 The \fBt_errno\fR values that can be set by the \fBXTI\fR interface and cannot
 194 be set by the \fBTLI\fR interface are:
 195 .br
 196 .in +2
 197 \fBTPROTO\fR
 198 .in -2
 199 .br
 200 .in +2
 201 \fBTOUTSTATE\fR
 202 .in -2
 203 .sp
 204 .LP
 205 A \fBt_errno\fR value that this routine can return under different
 206 circumstances than its \fBXTI\fR counterpart is \fBTBUFOVFLW.\fR It can be
 207 returned even when the \fBmaxlen\fR field of the corresponding buffer has been
 208 set to zero.
 209 .SS "Option Buffers"
 210 .sp
 211 .LP
 212 The format of the options in an \fBopt\fR buffer is dictated by the transport
 213 provider. Unlike the \fBXTI\fR interface, the \fBTLI\fR interface does not fix
 214 the buffer format.
 215 .SH ATTRIBUTES
 216 .sp
 217 .LP
 218 See \fBattributes\fR(5)  for descriptions of the following attributes:
 219 .sp
 220
 221 .sp
 222 .TS
 223 box;
 224 c | c
 225 l | l .
 226 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 227 _
 228 MT Level        Safe
 229 .TE
 230
 231 .SH SEE ALSO
 232 .sp
 233 .LP
 234 \fBfcntl\fR(2), \fBt_alloc\fR(3NSL), \fBt_open\fR(3NSL),
 235 \fBt_rcvuderr\fR(3NSL), \fBt_sndudata\fR(3NSL), \fBattributes\fR(5)