xref: /illumos-gate/usr/src/man/man3nsl/t_sndreldata.3nsl (revision 66582b606a8194f7f3ba5b3a3a6dca5b0d346361)

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.

T_SNDRELDATA 3NSL "May 7, 1998"
NAME
t_sndreldata - initiate or respond to an orderly release with user data
SYNOPSIS

#include <xti.h>




int t_sndreldata(int fd, struct t_discon *discon);
DESCRIPTION

This function is used to initiate an orderly release of the outgoing direction of data transfer and to send user data 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 calling t_sndreldata(), the user may not send any more data over the connection. However, a user may continue to receive data if an orderly release indication has not been received.

The field reason specifies the reason for the disconnection through a protocol-dependent reason code, and udata identifies any user data that is sent with the disconnection; the field sequence is not used.

The udata structure specifies the user data to be sent to the remote user. The amount of user data must not exceed the limits supported by the transport provider, as returned in the discon field of the info argument of t_open(3NSL) or t_getinfo(3NSL). If the len field of udata is zero or if the provider did not return T_ORDRELDATA in the t_open(3NSL) flags, no data will be sent to the remote user.

If a user does not wish to send data and reason code to the remote user, the value of discon may be a null pointer.

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.

This function may not be available on all systems.

RETURN VALUES

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.

VALID STATES

T_DATAXFER, T_INREL.

ERRORS

On failure, t_errno is set to one of the following: TBADDATA

The amount of user data specified was not within the bounds allowed by the transport provider, or user data was supplied and the provider did not return T_ORDRELDATA in the t_open(3NSL) flags.

TBADF

The specified file descriptor does not refer to a transport endpoint.

TFLOW

O_NONBLOCK was set, but the flow control mechanism prevented the transport provider from accepting the function at this time.

TLOOK

An asynchronous event has occurred on this transport endpoint and requires immediate attention.

TNOTSUPPORT

Orderly release is not supported by the underlying transport provider.

TOUTSTATE

The communications endpoint referenced by fd is not in one of the states in which a call to this function is valid.

TPROTO

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).

TSYSERR

A system error has occurred during execution of this function.

TLI COMPATIBILITY

In the TLI interface definition, no counterpart of this routine was defined.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT Level Safe
SEE ALSO

t_getinfo(3NSL), t_open(3NSL), t_rcvrel(3NSL), t_rcvreldata(3NSL), t_sndrel(3NSL), attributes(5)

NOTES

The interfaces t_sndreldata() and t_rcvreldata(3NSL) 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).