usr/src/man/man3nsl/t_unbind.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_UNBIND 3NSL "May 7, 1998"
  48 .SH NAME
  49 t_unbind \- disable a transport endpoint
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <xti.h>
  54
  55
  56
  57 \fBint\fR \fBt_unbind\fR(\fBint\fR \fIfd\fR);
  58 .fi
  59
  60 .SH DESCRIPTION
  61 .sp
  62 .LP
  63 The 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 \fBt_unbind()\fR function disables the transport endpoint specified by \fIfd\fR
  73 which was previously bound by \fBt_bind\fR(3NSL). On completion of this call,
  74 no further data or events destined for this transport endpoint will be accepted
  75 by the transport provider. An endpoint which is disabled by using
  76 \fBt_unbind()\fR can be enabled by a subsequent call to \fBt_bind\fR(3NSL).
  77 .SH RETURN VALUES
  78 .sp
  79 .LP
  80 Upon successful completion, a value of  \fB0\fR is returned.  Otherwise, a
  81 value of  -1 is returned and \fBt_errno\fR is set to indicate an error.
  82 .SH VALID STATES
  83 .sp
  84 .LP
  85 \fBT_IDLE\fR.
  86 .SH ERRORS
  87 .sp
  88 .LP
  89 On failure, \fBt_errno\fR is set to one of the following:
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBTBADF\fR\fR
  94 .ad
  95 .RS 13n
  96 The specified file descriptor does not refer to a transport endpoint.
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fBTLOOK\fR\fR
 103 .ad
 104 .RS 13n
 105 An asynchronous event has occurred on this transport endpoint.
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fBTOUTSTATE\fR\fR
 112 .ad
 113 .RS 13n
 114 The communications endpoint referenced by  \fIfd\fR is not in one of the states
 115 in which a call to this function is valid.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fBTPROTO\fR\fR
 122 .ad
 123 .RS 13n
 124 This error indicates that a communication problem has been detected between XTI
 125 and the transport provider for which there is no other suitable XTI error
 126 \fB(t_errno)\fR.
 127 .RE
 128
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fBTSYSERR\fR\fR
 133 .ad
 134 .RS 13n
 135 A system error has occurred during execution of this function.
 136 .RE
 137
 138 .SH TLI COMPATIBILITY
 139 .sp
 140 .LP
 141 The \fBXTI\fR and \fBTLI\fR interface definitions have common names but use
 142 different header files. This, and other semantic differences between the two
 143 interfaces are described in the subsections below.
 144 .SS "Interface Header"
 145 .sp
 146 .LP
 147 The \fBXTI\fR interfaces use the header file, \fBxti.h\fR \fB\&.\fR \fBTLI\fR
 148 interfaces should \fInot\fR use this header.  They should use the header:
 149 .br
 150 .in +2
 151 #include <tiuser.h>
 152 .in -2
 153 .SS "Error Description Values"
 154 .sp
 155 .LP
 156 The \fBt_errno\fR value that can be set by the \fBXTI\fR interface and cannot
 157 be set by the \fBTLI\fR interface is:
 158 .br
 159 .in +2
 160 \fBTPROTO\fR
 161 .in -2
 162 .SH ATTRIBUTES
 163 .sp
 164 .LP
 165 See \fBattributes\fR(5) for descriptions of the following attributes:
 166 .sp
 167
 168 .sp
 169 .TS
 170 box;
 171 c | c
 172 l | l .
 173 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 174 _
 175 MT-Level        MT-Safe
 176 .TE
 177
 178 .SH SEE ALSO
 179 .sp
 180 .LP
 181 \fBt_bind\fR(3NSL), \fBattributes\fR(5)