xref: /illumos-gate/usr/src/man/man3nsl/t_rcvconnect.3nsl (revision e3ae4b35c024af1196582063ecee3ab79367227d)

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_RCVCONNECT 3NSL "June 18, 2021"
NAME
t_rcvconnect - receive the confirmation from a connection request
SYNOPSIS
#include <xti.h>



int t_rcvconnect(int fd, struct t_call *call);
DESCRIPTION
This routine is part of the XTI interfaces which evolved from the TLI interfaces. XTI represents the future evolution of these interfaces. However, TLI interfaces are supported for compatibility. When using a TLI routine that has the same name as an XTI routine, the tiuser.h header file must be used. Refer to the TLI COMPATIBILITY section for a description of differences between the two interfaces.

This function enables a calling transport user to determine the status of a previously sent connection request and is used in conjunction with t_connect(3NSL) to establish a connection in asynchronous mode, and to complete a synchronous t_connect(3NSL) call that was interrupted by a signal. The connection will be established on successful completion of this function.

The argument fd identifies the local transport endpoint where communication will be established, and call contains information associated with the newly established connection. The argument call points to a t_call structure which contains the following members:

struct netbuf addr;
struct netbuf opt;
struct netbuf udata;
int sequence;

In call, addr returns the protocol address associated with the responding transport endpoint, opt presents any options associated with the connection, udata points to optional user data that may be returned by the destination transport user during connection establishment, and sequence has no meaning for this function.

The maxlen field of each argument must be set before issuing this function to indicate the maximum size of the buffer for each. However, maxlen can be set to zero, in which case no information to this specific argument is given to the user on the return from t_rcvconnect(). If call is set to NULL, no information at all is returned. By default, t_rcvconnect() executes in synchronous mode and waits for the connection to be established before returning. On return, the addr, opt and udata fields reflect values associated with the connection.

If O_NONBLOCK is set by means of t_open(3NSL) or fcntl(2), t_rcvconnect() executes in asynchronous mode, and reduces to a poll for existing connection confirmations. If none are available, t_rcvconnect() fails and returns immediately without waiting for the connection to be established. See TNODATA below. In this case, t_rcvconnect() must be called again to complete the connection establishment phase and retrieve the information returned in call.

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_OUTCON.
ERRORS
On failure, t_errno is set to one of the following: TBADF

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

TBUFOVFLW

The number of bytes allocated for an incoming argument (maxlen) is greater than 0 but not sufficient to store the value of that argument, and the connection information to be returned in call will be discarded. The provider's state, as seen by the user, will be changed to T_DATAXFER.

TLOOK

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

TNODATA

O_NONBLOCK was set, but a connection confirmation has not yet arrived.

TNOTSUPPORT

This function 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
The XTI and TLI interface definitions have common names but use different header files. This, and other semantic differences between the two interfaces are described in the subsections below.
"Interface Header"
The XTI interfaces use the header file, xti.h. TLI interfaces should not use this header. They should use the header:

#include <tiuser.h>

"Error Description Values"
The t_errno value TPROTO can be set by the XTI interface but not by the TLI interface.

A t_errno value that this routine can return under different circumstances than its XTI counterpart is TBUFOVFLW. It can be returned even when the maxlen field of the corresponding buffer has been set to zero.

ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
ATTRIBUTE TYPE ATTRIBUTE VALUE
MT Level Safe
SEE ALSO
fcntl (2), t_accept (3NSL), t_alloc (3NSL), t_bind (3NSL), t_connect (3NSL), t_listen (3NSL), t_open (3NSL), t_optmgmt (3NSL), attributes (7)