usr/src/man/man3nsl/t_getstate.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_GETSTATE 3NSL "May 7, 1998"
  11 .SH NAME
  12 t_getstate \- get the current state
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <xti.h>
  17
  18
  19
  20 \fBint\fR \fBt_getstate\fR(\fBint\fR \fIfd\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 The \fBt_getstate()\fR function returns the current state of the provider
  36 associated with the transport endpoint specified by \fIfd\fR.
  37 .SH RETURN VALUES
  38 .sp
  39 .LP
  40 State is returned upon successful completion.  Otherwise, a value of  -1 is
  41 returned and \fBt_errno\fR is set to indicate an error.  The current state is
  42 one of the following:
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fBT_UNBND\fR \fR
  47 .ad
  48 .RS 15n
  49 Unbound.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBT_IDLE\fR \fR
  56 .ad
  57 .RS 15n
  58 Idle.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBT_OUTCON\fR \fR
  65 .ad
  66 .RS 15n
  67 Outgoing connection pending.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBT_INCON\fR \fR
  74 .ad
  75 .RS 15n
  76 Incoming connection pending.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBT_DATAXFER\fR \fR
  83 .ad
  84 .RS 15n
  85 Data transfer.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBT_OUTREL\fR \fR
  92 .ad
  93 .RS 15n
  94 Outgoing direction orderly release sent.
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fBT_INREL\fR \fR
 101 .ad
 102 .RS 15n
 103 Incoming direction orderly release received.
 104 .RE
 105
 106 .sp
 107 .LP
 108 If the provider is undergoing a state transition when \fBt_getstate()\fR is
 109 called, the function will fail.
 110 .SH ERRORS
 111 .sp
 112 .LP
 113 On failure, \fBt_errno\fR is set to one of the following:
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBTBADF\fR\fR
 118 .ad
 119 .RS 14n
 120 The specified file descriptor does not refer to a transport endpoint.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fBTPROTO\fR\fR
 127 .ad
 128 .RS 14n
 129 This error indicates that a communication problem has been detected between XTI
 130 and the transport provider for which there is no other suitable XTI error
 131 \fB(t_errno)\fR.
 132 .RE
 133
 134 .sp
 135 .ne 2
 136 .na
 137 \fB\fBTSTATECHNG\fR\fR
 138 .ad
 139 .RS 14n
 140 The transport provider is undergoing a transient state change.
 141 .RE
 142
 143 .sp
 144 .ne 2
 145 .na
 146 \fB\fBTSYSERR\fR\fR
 147 .ad
 148 .RS 14n
 149 A system error has occurred during execution of this function.
 150 .RE
 151
 152 .SH TLI COMPATIBILITY
 153 .sp
 154 .LP
 155 The \fBXTI\fR and \fBTLI\fR interface definitions have common names but use
 156 different header files. This, and other semantic differences between the two
 157 interfaces are described in the subsections below.
 158 .SS "Interface Header"
 159 .sp
 160 .LP
 161 The \fBXTI\fR interfaces use the header file, \fBxti.h\fR. \fBTLI\fR interfaces
 162 should \fInot\fR use this header.  They should use the header:
 163 .sp
 164 .in +2
 165 .nf
 166 #include <tiuser.h>
 167 .fi
 168 .in -2
 169
 170 .SS "Error Description Values"
 171 .sp
 172 .LP
 173 The \fBt_errno\fR value that can be set by the \fBXTI\fR interface and cannot
 174 be set by the \fBTLI\fR interface is:
 175 .sp
 176 .LP
 177 \fBTPROTO\fR
 178 .SH ATTRIBUTES
 179 .sp
 180 .LP
 181 See \fBattributes\fR(5)  for descriptions of the following attributes:
 182 .sp
 183
 184 .sp
 185 .TS
 186 box;
 187 c | c
 188 l | l .
 189 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 190 _
 191 MT Level        Safe
 192 .TE
 193
 194 .SH SEE ALSO
 195 .sp
 196 .LP
 197 \fBt_open\fR(3NSL), \fBattributes\fR(5)