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
http://www.opengroup.org/bookstore/.
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 SunOS 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.
This notice shall appear on any product containing this material.
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.
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.
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]
Portions Copyright 1989 AT&T
Copyright 1994, The X/Open Company Ltd. All Rights Reserved.
Portions Copyright (c) 1998, Sun Microsystems, Inc. All Rights Reserved.
#include <xti.h> int t_rcvreldata(int fd, struct t_discon *discon);
This function is used to receive an orderly release indication for the incoming direction of data transfer and to retrieve any user data sent with the release. The argument fd identifies the local transport endpoint where the connection exists, and discon points to a t_discon structure containing the following members:
struct netbuf udata; int reason; int sequence;
After receipt of this indication, the user may not attempt to receive more data by means of t_rcv(3NSL) or t_rcvv(3NSL) Such an attempt will fail with t_error set to TOUTSTATE. However, the user may continue to send data over the connection if t_sndrel(3NSL) or t_sndreldata(3NSL) has not been called by the user.
The field reason specifies the reason for the disconnection through a protocol-dependent reason code, and udata identifies any user data that was sent with the disconnection; the field sequence is not used.
If a user does not care if there is incoming data and does not need to know the value of reason, discon may be a null pointer, and any user data associated with the disconnection will be discarded.
If discon\(->udata.maxlen is greater than zero and less than the length of the value, t_rcvreldata() fails with t_errno set to TBUFOVFLW.
This function is an optional service of the transport provider, only supported by providers of service type T_COTS_ORD. The flag T_ORDRELDATA in the info\(->flag field returned by t_open(3NSL) or t_getinfo(3NSL) indicates that the provider supports orderly release user data; when the flag is not set, this function behaves like t_rcvrel(3NSL) and no user data is returned.
This function may not be available on all systems.
Upon successful completion, a value of 0 is returned. Otherwise, a value of -1 is returned and t_errno is set to indicate an error.
T_DATAXFER, T_OUTREL.
On failure, t_errno is set to one of the following: TBADF
The specified file descriptor does not refer to a transport endpoint.
The number of bytes allocated for incoming data (maxlen) is greater than 0 but not sufficient to store the data, and the disconnection information to be returned in discon will be discarded. The provider state, as seen by the user, will be changed as if the data was successfully retrieved.
An asynchronous event has occurred on this transport endpoint and requires immediate attention.
No orderly release indication currently exists on the specified transport endpoint.
Orderly release is not supported by the underlying transport provider.
The communications endpoint referenced by fd is not in one of the states in which a call to this function is valid.
This error indicates that a communication problem has been detected between XTI and the transport provider for which there is no other suitable XTI error (t_errno).
A system error has occurred during execution of this function.
In the TLI interface definition, no counterpart of this routine was defined.
See attributes(7) for descriptions of the following attributes:
| ATTRIBUTE TYPE ATTRIBUTE VALUE |
| MT Level Safe |
t_getinfo (3NSL), t_open (3NSL), t_rcvrel (3NSL), t_sndrel (3NSL), t_sndreldata (3NSL), attributes (7)
The interfaces t_sndreldata(3NSL) and t_rcvreldata() are only for use with a specific transport called "minimal OSI," which is not available on the Solaris platform. These interfaces are not available for use in conjunction with Internet Transports (TCP or UDP).