usr/src/man/man3nsl/t_sync.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_SYNC 3NSL "May 7, 1998"
  48 .SH NAME
  49 t_sync \- synchronize transport library
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <xti.h>
  54
  55
  56
  57 \fBint\fR \fBt_sync\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 For the transport endpoint specified by \fIfd\fR, \fBt_sync()\fR synchronizes
  73 the data structures managed by the transport library with information from the
  74 underlying transport provider. In doing so, it can convert an uninitialized
  75 file descriptor (obtained by means of a  \fBopen\fR(2), \fBdup\fR(2) or as a
  76 result of a \fBfork\fR(2) and \fBexec\fR(2)) to an initialized transport
  77 endpoint, assuming that the file descriptor referenced a transport  endpoint,
  78 by updating and allocating the necessary library data structures. This function
  79 also allows two cooperating processes to synchronize their interaction with a
  80 transport provider.
  81 .sp
  82 .LP
  83 For example, if a process forks a new process and issues an \fBexec\fR(2), the
  84 new process must issue a \fBt_sync()\fR to build the private library data
  85 structure associated with a transport endpoint and to synchronize the data
  86 structure with the relevant provider information.
  87 .sp
  88 .LP
  89 It is important to remember that the transport provider treats all users of a
  90 transport endpoint as a single user. If multiple processes are using the same
  91 endpoint, they should coordinate their activities so as not to violate the
  92 state of the transport endpoint.  The function \fBt_sync()\fR returns the
  93 current state of the transport endpoint to the user, thereby enabling the user
  94 to verify the state before taking further action. This coordination is only
  95 valid among cooperating processes; it is possible that a process or an incoming
  96 event could change the endpoint's state \fIafter\fR a \fBt_sync()\fR is issued.
  97 .sp
  98 .LP
  99 If the transport endpoint is undergoing a state transition when \fBt_sync()\fR
 100 is called, the function will fail.
 101 .SH RETURN VALUES
 102 .sp
 103 .LP
 104 On successful completion, the state of the transport endpoint is returned.
 105 Otherwise, a value of  -1 is returned and \fBt_errno\fR is set to indicate an
 106 error. The state returned is one of the following:
 107 .sp
 108 .ne 2
 109 .na
 110 \fB\fBT_UNBND\fR \fR
 111 .ad
 112 .RS 15n
 113 Unbound.
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fBT_IDLE\fR \fR
 120 .ad
 121 .RS 15n
 122 Idle.
 123 .RE
 124
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fBT_OUTCON\fR \fR
 129 .ad
 130 .RS 15n
 131 Outgoing connection pending.
 132 .RE
 133
 134 .sp
 135 .ne 2
 136 .na
 137 \fB\fBT_INCON\fR \fR
 138 .ad
 139 .RS 15n
 140 Incoming connection pending.
 141 .RE
 142
 143 .sp
 144 .ne 2
 145 .na
 146 \fB\fBT_DATAXFER\fR \fR
 147 .ad
 148 .RS 15n
 149 Data transfer.
 150 .RE
 151
 152 .sp
 153 .ne 2
 154 .na
 155 \fB\fBT_OUTREL\fR \fR
 156 .ad
 157 .RS 15n
 158 Outgoing orderly release (waiting for an orderly release indication).
 159 .RE
 160
 161 .sp
 162 .ne 2
 163 .na
 164 \fB\fBT_INREL\fR \fR
 165 .ad
 166 .RS 15n
 167 Incoming orderly release (waiting for an orderly release request).
 168 .RE
 169
 170 .SH ERRORS
 171 .sp
 172 .LP
 173 On failure, \fBt_errno\fR is set to one of the following:
 174 .sp
 175 .ne 2
 176 .na
 177 \fB\fBTBADF\fR\fR
 178 .ad
 179 .RS 14n
 180 The specified file descriptor does not refer to a transport endpoint. This
 181 error may be returned when the \fIfd\fR has been previously closed or an
 182 erroneous number may have been passed to the call.
 183 .RE
 184
 185 .sp
 186 .ne 2
 187 .na
 188 \fB\fBTPROTO\fR\fR
 189 .ad
 190 .RS 14n
 191 This error indicates that a communication problem has been detected between XTI
 192 and the transport provider for which there is no other suitable XTI error
 193 \fB(t_errno)\fR.
 194 .RE
 195
 196 .sp
 197 .ne 2
 198 .na
 199 \fB\fBTSTATECHNG\fR\fR
 200 .ad
 201 .RS 14n
 202 The transport endpoint is undergoing a state change.
 203 .RE
 204
 205 .sp
 206 .ne 2
 207 .na
 208 \fB\fBTSYSERR\fR\fR
 209 .ad
 210 .RS 14n
 211 A system error has occurred during execution of this function.
 212 .RE
 213
 214 .SH TLI COMPATIBILITY
 215 .sp
 216 .LP
 217 The \fBXTI\fR and \fBTLI\fR interface definitions have common names but use
 218 different header files. This, and other semantic differences between the two
 219 interfaces are described in the subsections below.
 220 .SS "Interface Header"
 221 .sp
 222 .LP
 223 The \fBXTI\fR interfaces use the header file, \fBxti.h\fR. \fBTLI\fR interfaces
 224 should \fInot\fR use this header.  They should use the header:
 225 .br
 226 .in +2
 227 #include <tiuser.h>
 228 .in -2
 229 .SS "Error Description Values"
 230 .sp
 231 .LP
 232 The \fBt_errno\fR value that can be set by the \fBXTI\fR interface and cannot
 233 be set by the \fBTLI\fR interface is:
 234 .br
 235 .in +2
 236 \fBTPROTO\fR
 237 .in -2
 238 .SH ATTRIBUTES
 239 .sp
 240 .LP
 241 See \fBattributes\fR(5)  for descriptions of the following attributes:
 242 .sp
 243
 244 .sp
 245 .TS
 246 box;
 247 c | c
 248 l | l .
 249 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 250 _
 251 MT Level        Safe
 252 .TE
 253
 254 .SH SEE ALSO
 255 .sp
 256 .LP
 257 \fBdup\fR(2), \fBexec\fR(2), \fBfork\fR(2), \fBopen\fR(2), \fBattributes\fR(5)