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

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_GETSTATE 3NSL "May 7, 1998"
NAME
t_getstate - get the current state
SYNOPSIS

#include <xti.h>



int t_getstate(int fd);
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.

The t_getstate() function returns the current state of the provider associated with the transport endpoint specified by fd.

RETURN VALUES

State is returned upon successful completion. Otherwise, a value of -1 is returned and t_errno is set to indicate an error. The current state is one of the following: T_UNBND

Unbound.

T_IDLE

Idle.

T_OUTCON

Outgoing connection pending.

T_INCON

Incoming connection pending.

T_DATAXFER

Data transfer.

T_OUTREL

Outgoing direction orderly release sent.

T_INREL

Incoming direction orderly release received.

If the provider is undergoing a state transition when t_getstate() is called, the function will fail.

ERRORS

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

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

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

TSTATECHNG

The transport provider is undergoing a transient state change.

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 that can be set by the XTI interface and cannot be set by the TLI interface is:

TPROTO

ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT Level Safe
SEE ALSO

t_open(3NSL), attributes(5)