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

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   4 .\" Copyright 1991, 1992, 1994, The X/Open Company Ltd.
   5 .\" 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
   6 .\" http://www.opengroup.org/bookstore/.
   7 .\" 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.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" 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.
  10 .\" 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.
  11 .\" 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]
  12 .TH PTHREAD_JOIN 3C "Mar 23, 2005"
  13 .SH NAME
  14 pthread_join \- wait for thread termination
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 cc -mt [ \fIflag\fR... ] \fIfile\fR... -lpthread [ \fIlibrary\fR... ]
  19 #include <pthread.h>
  20
  21 \fBint\fR \fBpthread_join\fR(\fBpthread_t\fR \fIthread\fR, \fBvoid **\fR\fIstatus\fR);
  22 .fi
  23
  24 .SH DESCRIPTION
  25 .sp
  26 .LP
  27 The \fBpthread_join()\fR function suspends processing of the calling thread
  28 until the target \fIthread\fR completes. \fIthread\fR must be a member of the
  29 current process and it cannot be a detached thread. See
  30 \fBpthread_create\fR(3C).
  31 .sp
  32 .LP
  33 If two or more threads wait for the same thread to complete, all will suspend
  34 processing until the thread has terminated, and then one thread will return
  35 successfully and the others will return with an error of \fBESRCH\fR. The
  36 \fBpthread_join()\fR function will not block processing of the calling thread
  37 if the target \fIthread\fR has already terminated.
  38 .sp
  39 .LP
  40 If a \fBpthread_join()\fR call returns successfully with a non-null
  41 \fIstatus\fR argument, the value passed to \fBpthread_exit\fR(3C) by the
  42 terminating thread will be placed in the location referenced by \fIstatus\fR.
  43 .sp
  44 .LP
  45 If the \fBpthread_join()\fR calling thread is cancelled, then the target
  46 \fIthread\fR will remain joinable by \fBpthread_join()\fR. However, the calling
  47 thread may set up a cancellation cleanup handler on \fIthread\fR prior to the
  48 join call, which may detach the target \fIthread\fR by calling
  49 \fBpthread_detach\fR(3C). See \fBpthread_detach\fR(3C) and
  50 \fBpthread_cancel\fR(3C).
  51 .SH RETURN VALUES
  52 .sp
  53 .LP
  54 If successful, \fBpthread_join()\fR returns \fB0\fR. Otherwise, an error number
  55 is returned to indicate the error.
  56 .SH ERRORS
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fBEDEADLK\fR\fR
  61 .ad
  62 .RS 11n
  63 A joining deadlock would occur, such as when a thread attempts to wait for
  64 itself.
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fBEINVAL\fR\fR
  71 .ad
  72 .RS 11n
  73 The thread corresponding to the given thread ID is a detached thread.
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBESRCH\fR\fR
  80 .ad
  81 .RS 11n
  82 No thread could be found corresponding to the given thread ID.
  83 .RE
  84
  85 .SH ATTRIBUTES
  86 .sp
  87 .LP
  88 See \fBattributes\fR(5) for descriptions of the following attributes:
  89 .sp
  90
  91 .sp
  92 .TS
  93 box;
  94 c | c
  95 l | l .
  96 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  97 _
  98 Interface Stability     Standard
  99 _
 100 MT-Level        MT-Safe
 101 .TE
 102
 103 .SH SEE ALSO
 104 .sp
 105 .LP
 106 \fBpthread_cancel\fR(3C), \fBpthread_create\fR(3C), \fBpthread_detach\fR(3C),
 107 \fBpthread_exit\fR(3C), \fBwait\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)
 108 .SH NOTES
 109 .sp
 110 .LP
 111 The pthread_join(3C) function must specify the \fIthread\fR \fBID\fR for whose
 112 termination it will wait.
 113 .sp
 114 .LP
 115 Calling \fBpthread_join()\fR also "detaches" the thread; that is,
 116 \fBpthread_join()\fR includes the effect of the \fBpthread_detach()\fR
 117 function. If a thread were to be cancelled when blocked in
 118 \fBpthread_join()\fR, an explicit detach would have to be performed in the
 119 cancellation cleanup handler. The \fBpthread_detach()\fR function exists
 120 primarily for this purpose.