usr/src/man/man3nsl/t_rcvuderr.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_RCVUDERR 3NSL "May 7, 1998"
  11 .SH NAME
  12 t_rcvuderr \- receive a unit data error indication
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <xti.h>
  17
  18
  19
  20 \fBint\fR \fBt_rcvuderr\fR(\fBint\fR \fIfd\fR, \fBstruct t_uderr *\fR\fIuderr\fR);
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 This routine 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 routine that has the same name as an \fBXTI\fR routine, 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 is used in connectionless-mode to receive information concerning
  36 an error on a previously sent data unit, and should only be issued following a
  37 unit data error indication. It informs the transport user that a data unit with
  38 a specific destination address and protocol options produced an error. The
  39 argument \fIfd\fR identifies the local transport endpoint through which the
  40 error report will be received, and \fIuderr\fR points to a \fBt_uderr\fR
  41 structure containing the following members:
  42 .sp
  43 .in +2
  44 .nf
  45 struct netbuf addr;
  46 struct netbuf opt;
  47 t_scalar_t error;
  48 .fi
  49 .in -2
  50
  51 .sp
  52 .LP
  53 The \fImaxlen\fR field of \fIaddr\fR and \fIopt\fR must be set before calling
  54 this function to indicate the maximum size of the buffer for each. If this
  55 field is set to zero for  \fIaddr\fR or  \fIopt\fR, no information is returned
  56 in the  \fIbuf\fR field of this parameter.
  57 .sp
  58 .LP
  59 On return from this call, the \fIaddr\fR structure specifies the destination
  60 protocol address of the erroneous data unit, the \fIopt\fR structure identifies
  61 options that were associated with the data unit, and \fBerror\fR specifies a
  62 protocol-dependent error code.
  63 .sp
  64 .LP
  65 If the user does not care to identify the data unit that produced an error,
  66 \fIuderr\fR may be set to a null pointer, and \fBt_rcvuderr()\fR will simply
  67 clear the error indication without reporting any information to the user.
  68 .SH RETURN VALUES
  69 .sp
  70 .LP
  71 Upon successful completion, a value of  \fB0\fR is returned.  Otherwise, a
  72 value of  -1 is returned and \fBt_errno\fR is set to indicate an error.
  73 .SH VALID STATES
  74 .sp
  75 .LP
  76 \fBT_IDLE\fR.
  77 .SH ERRORS
  78 .sp
  79 .LP
  80 On failure, \fBt_errno\fR is set to one of the following:
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBTBADF\fR\fR
  85 .ad
  86 .RS 15n
  87 The specified file descriptor does not refer to a transport endpoint.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBTBUFOVFLW\fR\fR
  94 .ad
  95 .RS 15n
  96 The number of bytes allocated for the incoming protocol address or options
  97 \fI(maxlen)\fR is greater than 0 but not sufficient to store the information.
  98 The unit data error information to be returned in \fIuderr\fR will be
  99 discarded.
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fBTNOTSUPPORT\fR\fR
 106 .ad
 107 .RS 15n
 108 This function is not supported by the underlying transport provider.
 109 .RE
 110
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fBTNOUDERR\fR\fR
 115 .ad
 116 .RS 15n
 117 No unit data error indication currently exists on the specified transport
 118 endpoint.
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fBTOUTSTATE\fR\fR
 125 .ad
 126 .RS 15n
 127 The communications endpoint referenced by \fIfd\fR is not in one of the states
 128 in which a call to this function is valid.
 129 .RE
 130
 131 .sp
 132 .ne 2
 133 .na
 134 \fB\fBTPROTO\fR\fR
 135 .ad
 136 .RS 15n
 137 This error indicates that a communication problem has been detected between XTI
 138 and the transport provider for which there is no other suitable XTI error
 139 \fB(t_errno)\fR.
 140 .RE
 141
 142 .sp
 143 .ne 2
 144 .na
 145 \fB\fBTSYSERR\fR\fR
 146 .ad
 147 .RS 15n
 148 A system error has occurred during execution of this function.
 149 .RE
 150
 151 .SH TLI COMPATIBILITY
 152 .sp
 153 .LP
 154 The \fBXTI\fR and \fBTLI\fR interface definitions have common names but use
 155 different header files. This, and other semantic differences between the two
 156 interfaces are described in the subsections below.
 157 .SS "Interface Header"
 158 .sp
 159 .LP
 160 The \fBXTI\fR interfaces use the header file, \fBxti.h\fR. \fBTLI\fR interfaces
 161 should \fInot\fR use this header.  They should use the header:
 162 .br
 163 .in +2
 164 \fB#include <tiuser.h>\fR
 165 .in -2
 166 .SS "Error Description Values"
 167 .sp
 168 .LP
 169 The \fBt_errno\fR values \fBTPROTO\fR and \fBTOUTSTATE\fR can be set by the
 170 \fBXTI\fR interface but not by the \fBTLI\fR interface.
 171 .sp
 172 .LP
 173 A \fBt_errno\fR value that this routine can return under different
 174 circumstances than its \fBXTI\fR counterpart is \fBTBUFOVFLW.\fR It can be
 175 returned even when the \fBmaxlen\fR field of the corresponding buffer has been
 176 set to zero.
 177 .SS "Option Buffers"
 178 .sp
 179 .LP
 180 The format of the options in an \fBopt\fR buffer is dictated by the transport
 181 provider. Unlike the \fBXTI\fR interface, the \fBTLI\fR interface does not fix
 182 the buffer format.
 183 .SH ATTRIBUTES
 184 .sp
 185 .LP
 186 See \fBattributes\fR(5)  for descriptions of the following attributes:
 187 .sp
 188
 189 .sp
 190 .TS
 191 box;
 192 c | c
 193 l | l .
 194 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 195 _
 196 MT Level        Safe
 197 .TE
 198
 199 .SH SEE ALSO
 200 .sp
 201 .LP
 202 \fBt_rcvudata\fR(3NSL), \fBt_sndudata\fR(3NSL), \fBattributes\fR(5)