usr/src/man/man3nsl/t_getstate.3nsl

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Portions Copyright 1989 AT&T
  44 .\" Copyright 1994, The X/Open Company Ltd.  All Rights Reserved.
  45 .\" Portions Copyright (c) 1998, Sun Microsystems, Inc.  All Rights Reserved.
  46 .\"
  47 .TH T_GETSTATE 3NSL "May 7, 1998"
  48 .SH NAME
  49 t_getstate \- get the current state
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <xti.h>
  54
  55
  56
  57 \fBint\fR \fBt_getstate\fR(\fBint\fR \fIfd\fR);
  58 .fi
  59
  60 .SH DESCRIPTION
  61 .sp
  62 .LP
  63 This routine is part of the \fBXTI\fR interfaces which evolved from the
  64 \fBTLI\fR interfaces. \fBXTI\fR represents the future evolution of these
  65 interfaces. However, \fBTLI\fR interfaces are supported for compatibility. When
  66 using a \fBTLI\fR routine that has the same name as an \fBXTI\fR routine, the
  67 \fBtiuser.h\fR header file must be used.  Refer to the  \fBTLI\fR
  68 \fBCOMPATIBILITY\fR section for a description of differences between the two
  69 interfaces.
  70 .sp
  71 .LP
  72 The \fBt_getstate()\fR function returns the current state of the provider
  73 associated with the transport endpoint specified by \fIfd\fR.
  74 .SH RETURN VALUES
  75 .sp
  76 .LP
  77 State is returned upon successful completion.  Otherwise, a value of  -1 is
  78 returned and \fBt_errno\fR is set to indicate an error.  The current state is
  79 one of the following:
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBT_UNBND\fR \fR
  84 .ad
  85 .RS 15n
  86 Unbound.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fBT_IDLE\fR \fR
  93 .ad
  94 .RS 15n
  95 Idle.
  96 .RE
  97
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fBT_OUTCON\fR \fR
 102 .ad
 103 .RS 15n
 104 Outgoing connection pending.
 105 .RE
 106
 107 .sp
 108 .ne 2
 109 .na
 110 \fB\fBT_INCON\fR \fR
 111 .ad
 112 .RS 15n
 113 Incoming connection pending.
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fBT_DATAXFER\fR \fR
 120 .ad
 121 .RS 15n
 122 Data transfer.
 123 .RE
 124
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fBT_OUTREL\fR \fR
 129 .ad
 130 .RS 15n
 131 Outgoing direction orderly release sent.
 132 .RE
 133
 134 .sp
 135 .ne 2
 136 .na
 137 \fB\fBT_INREL\fR \fR
 138 .ad
 139 .RS 15n
 140 Incoming direction orderly release received.
 141 .RE
 142
 143 .sp
 144 .LP
 145 If the provider is undergoing a state transition when \fBt_getstate()\fR is
 146 called, the function will fail.
 147 .SH ERRORS
 148 .sp
 149 .LP
 150 On failure, \fBt_errno\fR is set to one of the following:
 151 .sp
 152 .ne 2
 153 .na
 154 \fB\fBTBADF\fR\fR
 155 .ad
 156 .RS 14n
 157 The specified file descriptor does not refer to a transport endpoint.
 158 .RE
 159
 160 .sp
 161 .ne 2
 162 .na
 163 \fB\fBTPROTO\fR\fR
 164 .ad
 165 .RS 14n
 166 This error indicates that a communication problem has been detected between XTI
 167 and the transport provider for which there is no other suitable XTI error
 168 \fB(t_errno)\fR.
 169 .RE
 170
 171 .sp
 172 .ne 2
 173 .na
 174 \fB\fBTSTATECHNG\fR\fR
 175 .ad
 176 .RS 14n
 177 The transport provider is undergoing a transient state change.
 178 .RE
 179
 180 .sp
 181 .ne 2
 182 .na
 183 \fB\fBTSYSERR\fR\fR
 184 .ad
 185 .RS 14n
 186 A system error has occurred during execution of this function.
 187 .RE
 188
 189 .SH TLI COMPATIBILITY
 190 .sp
 191 .LP
 192 The \fBXTI\fR and \fBTLI\fR interface definitions have common names but use
 193 different header files. This, and other semantic differences between the two
 194 interfaces are described in the subsections below.
 195 .SS "Interface Header"
 196 .sp
 197 .LP
 198 The \fBXTI\fR interfaces use the header file, \fBxti.h\fR. \fBTLI\fR interfaces
 199 should \fInot\fR use this header.  They should use the header:
 200 .sp
 201 .in +2
 202 .nf
 203 #include <tiuser.h>
 204 .fi
 205 .in -2
 206
 207 .SS "Error Description Values"
 208 .sp
 209 .LP
 210 The \fBt_errno\fR value that can be set by the \fBXTI\fR interface and cannot
 211 be set by the \fBTLI\fR interface is:
 212 .sp
 213 .LP
 214 \fBTPROTO\fR
 215 .SH ATTRIBUTES
 216 .sp
 217 .LP
 218 See \fBattributes\fR(5)  for descriptions of the following attributes:
 219 .sp
 220
 221 .sp
 222 .TS
 223 box;
 224 c | c
 225 l | l .
 226 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 227 _
 228 MT Level        Safe
 229 .TE
 230
 231 .SH SEE ALSO
 232 .sp
 233 .LP
 234 \fBt_open\fR(3NSL), \fBattributes\fR(5)