usr/src/man/man3nsl/t_rcvdis.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_RCVDIS 3NSL "May 7, 1998"
  11 .SH NAME
  12 t_rcvdis \- retrieve information from disconnection
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <xti.h>
  17
  18
  19
  20 \fBint\fR \fBt_rcvdis\fR(\fBint\fR \fIfd\fR, \fBstruct t_discon *\fR\fIdiscon\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 to identify the cause of a disconnection and to retrieve
  36 any user data sent with the disconnection. The argument \fIfd\fR identifies the
  37 local transport endpoint where the connection existed, and \fIdiscon\fR points
  38 to a \fBt_discon\fR structure containing the following members:
  39 .sp
  40 .in +2
  41 .nf
  42 struct netbuf udata;
  43 int reason;
  44 int sequence;
  45 .fi
  46 .in -2
  47
  48 .sp
  49 .LP
  50 The field \fIreason\fR specifies the reason for the disconnection through a
  51 protocol-dependent reason code, \fIudata\fR identifies any user data that was
  52 sent with the disconnection, and \fIsequence\fR may identify an outstanding
  53 connection indication with which the disconnection is associated.  The field
  54 \fIsequence\fR is only meaningful when \fBt_rcvdis()\fR is issued by a passive
  55 transport user who has executed one or more \fBt_listen\fR(3NSL) functions and
  56 is processing the resulting connection indications. If a disconnection
  57 indication occurs, \fIsequence\fR can be used to identify which of the
  58 outstanding connection indications is associated with the disconnection.
  59 .sp
  60 .LP
  61 The  \fImaxlen\fR field of  \fIudata\fR may be set to zero, if the user does
  62 not care about incoming data. If, in addition, the user does not need to know
  63 the value of  \fIreason\fR or  \fIsequence\fR, \fIdiscon\fR may be set to
  64 \fINULL\fR and any user data associated with the disconnection indication shall
  65 be discarded. However, if a user has retrieved more than one outstanding
  66 connection indication by means of \fBt_listen\fR(3NSL), and \fIdiscon\fR is a
  67 null pointer, the user will be unable to identify with which connection
  68 indication the disconnection is associated.
  69 .SH RETURN VALUES
  70 .sp
  71 .LP
  72 Upon successful completion, a value of  \fB0\fR is returned.  Otherwise, a
  73 value of  -1 is returned and \fBt_errno\fR is set to indicate an error.
  74 .SH VALID STATES
  75 .sp
  76 .LP
  77 \fBT_DATAXFER\fR, \fBT_OUTCON\fR, \fBT_OUTREL\fR, \fBT_INREL\fR,
  78 \fBT_INCON(ocnt > 0)\fR.
  79 .SH ERRORS
  80 .sp
  81 .LP
  82 On failure, \fBt_errno\fR is set to one of the following:
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBTBADF\fR\fR
  87 .ad
  88 .RS 15n
  89 The specified file descriptor does not refer to a transport endpoint.
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fBTBUFOVFLW\fR\fR
  96 .ad
  97 .RS 15n
  98 The number of bytes allocated for incoming data \fI(maxlen)\fR is greater than
  99 \fB0\fR but not sufficient to store the data.  If \fIfd\fR is a passive
 100 endpoint with \fIocnt\fR > 1, it remains in state  \fBT_INCON;\fR otherwise,
 101 the endpoint state is set to  \fBT_IDLE.\fR
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBTNODIS\fR\fR
 108 .ad
 109 .RS 15n
 110 No disconnection indication currently exists on the specified transport
 111 endpoint.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBTNOTSUPPORT\fR\fR
 118 .ad
 119 .RS 15n
 120 This function is not supported by the underlying transport provider.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fBTOUTSTATE\fR\fR
 127 .ad
 128 .RS 15n
 129 The communications endpoint referenced by  \fIfd\fR is not in one of the states
 130 in which a call to this function is valid.
 131 .RE
 132
 133 .sp
 134 .ne 2
 135 .na
 136 \fB\fBTPROTO\fR\fR
 137 .ad
 138 .RS 15n
 139 This error indicates that a communication problem has been detected between XTI
 140 and the transport provider for which there is no other suitable XTI error
 141 \fB(t_errno)\fR.
 142 .RE
 143
 144 .sp
 145 .ne 2
 146 .na
 147 \fB\fBTSYSERR\fR\fR
 148 .ad
 149 .RS 15n
 150 A system error has occurred during execution of this function.
 151 .RE
 152
 153 .SH TLI COMPATIBILITY
 154 .sp
 155 .LP
 156 The \fBXTI\fR and \fBTLI\fR interface definitions have common names but use
 157 different header files. This, and other semantic differences between the two
 158 interfaces are described in the subsections below.
 159 .SS "Interface Header"
 160 .sp
 161 .LP
 162 The \fBXTI\fR interfaces use the header file, \fBxti.h\fR. \fBTLI\fR interfaces
 163 should \fInot\fR use this header.  They should use the header:
 164 .br
 165 .in +2
 166 #include <tiuser.h>
 167 .in -2
 168 .SS "Error Description Values"
 169 .sp
 170 .LP
 171 The \fBt_errno\fR values \fBTPROTO\fR and \fBTOUTSTATE\fR can be set by the
 172 \fBXTI\fR interface but not by the \fBTLI\fR interface.
 173 .sp
 174 .LP
 175 A failure return, and a \fBt_errno\fR value that this routine can set under
 176 different circumstances than its \fBXTI\fR counterpart is \fBTBUFOVFLW.\fR It
 177 can be returned even when the \fBmaxlen\fR field of the corresponding buffer
 178 has been set to zero.
 179 .SH ATTRIBUTES
 180 .sp
 181 .LP
 182 See \fBattributes\fR(5)  for descriptions of the following attributes:
 183 .sp
 184
 185 .sp
 186 .TS
 187 box;
 188 c | c
 189 l | l .
 190 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 191 _
 192 MT Level        Safe
 193 .TE
 194
 195 .SH SEE ALSO
 196 .sp
 197 .LP
 198 \fBt_alloc\fR(3NSL), \fBt_connect\fR(3NSL), \fBt_listen\fR(3NSL),
 199 \fBt_open\fR(3NSL), \fBt_snddis\fR(3NSL), \fBattributes\fR(5)