pthreads/pthread_join.3

   1 .\" Copyright (c) 1996-1998 John Birrell <jb@cimlogic.com.au>.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by John Birrell.
  15 .\" 4. Neither the name of the author nor the names of any co-contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD: src/lib/libc_r/man/pthread_join.3,v 1.7.2.4 2001/08/17 15:42:51 ru Exp $
  32 .\"
  33 .Dd April 4, 1996
  34 .Dt PTHREAD_JOIN 3
  35 .Os
  36 .Sh NAME
  37 .Nm pthread_join
  38 .Nd wait for thread termination
  39 .Sh SYNOPSIS
  40 .Fd #include <pthread.h>
  41 .Ft int
  42 .Fo pthread_join
  43 .Fa "pthread_t thread"
  44 .Fa "void **value_ptr"
  45 .Fc
  46 .Sh DESCRIPTION
  47 The
  48 .Fn pthread_join
  49 function suspends execution of the calling thread until the target
  50 .Fa thread
  51 terminates, unless the target
  52 .Fa thread
  53 has already terminated.
  54 .Pp
  55 On return from a successful
  56 .Fn pthread_join
  57 call with a non-NULL
  58 .Fa value_ptr
  59 argument, the value passed to
  60 .Fn pthread_exit
  61 by the terminating thread is stored in the location referenced by
  62 .Fa value_ptr .
  63 When a
  64 .Fn pthread_join
  65 returns successfully, the target thread has been terminated.
  66 The results
  67 of multiple simultaneous calls to
  68 .Fn pthread_join ,
  69 specifying the same target thread, are undefined.
  70 If the thread calling
  71 .Fn pthread_join
  72 is cancelled, the target thread is not detached.
  73 .Pp
  74 .Sh RETURN VALUES
  75 If successful,  the
  76 .Fn pthread_join
  77 function will return zero.
  78 Otherwise, an error number will be returned to
  79 indicate the error.
  80 .Sh ERRORS
  81 .Fn pthread_join
  82 will fail if:
  83 .Bl -tag -width Er
  84 .It Bq Er EDEADLK
  85 A deadlock was detected or the value of
  86 .Fa thread
  87 specifies the calling thread.
  88 .It Bq Er EINVAL
  89 The implementation has detected that the value specified by
  90 .Fa thread
  91 does not refer to a joinable thread.
  92 .It Bq Er ESRCH
  93 No thread could be found corresponding to that specified by the given
  94 thread ID,
  95 .Fa thread .
  96 .El
  97 .Sh SEE ALSO
  98 .Xr wait 2 ,
  99 .Xr pthread_create 3
 100 .Sh STANDARDS
 101 .Fn pthread_join
 102 conforms to
 103 .St -p1003.1-96 .