usr/src/man/man3c/thr_join.3c

   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 (c) 1995 IEEE.  All Rights Reserved.
  44 .\" Copyright (c) 2000 Sun Microsystems, Inc.  All Rights Reserved.
  45 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  46 .\"
  47 .TH THR_JOIN 3C "Mar 27, 2000"
  48 .SH NAME
  49 thr_join \- wait for thread termination
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 cc -mt [ \fIflag\fR... ] \fIfile\fR...[ \fIlibrary\fR... ]
  54 #include <thread.h>
  55
  56 \fBint\fR \fBthr_join\fR(\fBthread_t\fR \fIthread\fR, \fBthread_t *\fR\fIdeparted\fR, \fBvoid **\fR\fIstatus\fR);
  57 .fi
  58
  59 .SH DESCRIPTION
  60 .sp
  61 .LP
  62 The \fBthr_join()\fR function suspends processing of the calling thread until
  63 the target \fIthread\fR completes. The \fIthread\fR argument must be a member
  64 of the current process and cannot be a detached thread. See
  65 \fBthr_create\fR(3C).
  66 .sp
  67 .LP
  68 If two or more threads wait for the same thread to complete, all will suspend
  69 processing until the thread has terminated, and then one thread will return
  70 successfully and the others will return with an error of \fBESRCH\fR. The
  71 \fBthr_join()\fR function will not block processing of the calling thread if
  72 the target \fIthread\fR has already terminated.
  73 .sp
  74 .LP
  75 If a \fBthr_join()\fR call returns successfully with a non-null \fIstatus\fR
  76 argument, the value passed to \fBthr_exit\fR(3C) by the terminating thread will
  77 be placed in the location referenced by \fIstatus\fR.
  78 .sp
  79 .LP
  80 If the target \fIthread\fR \fBID\fR is  \fB0\fR, \fBthr_join()\fR finds and
  81 returns the status of a terminated undetached thread in the process. If no such
  82 thread exists, it suspends processing of the calling thread until a thread for
  83 which no other thread is waiting enters that state, at which time it returns
  84 successfully, or until all other threads in the process are either daemon
  85 threads or threads waiting in \fBthr_join()\fR, in which case it returns
  86 \fBEDEADLK\fR. See \fBNOTES\fR.
  87 .sp
  88 .LP
  89 If \fIdeparted\fR is not \fINULL\fR, it points to a location that is set to the
  90 ID of the terminated thread if \fBthr_join()\fR returns successfully.
  91 .SH RETURN VALUES
  92 .sp
  93 .LP
  94 If successful, \fBthr_join()\fR returns \fB0\fR. Otherwise, an error number is
  95 returned to indicate the error.
  96 .SH ERRORS
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fBEDEADLK\fR \fR
 101 .ad
 102 .RS 12n
 103 A joining deadlock would occur, such as when a thread attempts to wait for
 104 itself, or the calling thread is waiting for any thread to exit and only daemon
 105 threads or waiting threads exist in the process.
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fBESRCH\fR \fR
 112 .ad
 113 .RS 12n
 114 No undetached thread could be found corresponding to the given thread ID.
 115 .RE
 116
 117 .SH ATTRIBUTES
 118 .sp
 119 .LP
 120 See \fBattributes\fR(5) for descriptions of the following attributes:
 121 .sp
 122
 123 .sp
 124 .TS
 125 box;
 126 c | c
 127 l | l .
 128 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 129 _
 130 MT-Level        MT-Safe
 131 .TE
 132
 133 .SH SEE ALSO
 134 .sp
 135 .LP
 136 \fBthr_create\fR(3C), \fBthr_exit\fR(3C), \fBwait\fR(3C), \fBattributes\fR(5),
 137 \fBstandards\fR(5)
 138 .SH NOTES
 139 .sp
 140 .LP
 141 Using thr_join(3C) in the following syntax,
 142 .sp
 143 .in +2
 144 .nf
 145 while (thr_join(0, NULL, NULL) == 0);
 146 .fi
 147 .in -2
 148
 149 .sp
 150 .LP
 151 will wait for the termination of all non-daemon threads, excluding threads that
 152 are themselves waiting in \fBthr_join()\fR.