pthread_join(3) [freebsd man page]

PTHREAD_JOIN(3) 					   BSD Library Functions Manual 					   PTHREAD_JOIN(3)

NAME

     pthread_join, pthread_timedjoin_np -- wait for thread termination

LIBRARY

     POSIX Threads Library (libpthread, -lpthread)

SYNOPSIS

     #include <pthread.h>

     int
     pthread_join(pthread_t thread, void **value_ptr);

     int
     pthread_timedjoin_np(pthread_t thread, void **value_ptr, const struct timespec *abstime);

DESCRIPTION

     The pthread_join() function suspends execution of the calling thread until the target thread terminates unless the target thread has already
     terminated.

     On return from a successful pthread_join() call with a non-NULL value_ptr argument, the value passed to pthread_exit() by the terminating
     thread is stored in the location referenced by value_ptr.	When a pthread_join() returns successfully, the target thread has been terminated.
     The results of multiple simultaneous calls to pthread_join() specifying the same target thread are undefined.  If the thread calling
     pthread_join() is cancelled, then the target thread is not detached.

     The pthread_timedjoin_np() function is equivalent to the pthread_join() function except it will return ETIMEDOUT if target thread does not
     exit before specified absolute time passes.

     A thread that has exited but remains unjoined counts against [_POSIX_THREAD_THREADS_MAX].

RETURN VALUES

     If successful, the pthread_join() and pthread_timedjoin_np() functions will return zero.  Otherwise an error number will be returned to indi-
     cate the error.

ERRORS

     The pthread_join() and pthread_timedjoin_np() functions will fail if:

     [EINVAL]		The implementation has detected that the value specified by thread does not refer to a joinable thread.

     [ESRCH]		No thread could be found corresponding to that specified by the given thread ID, thread.

     [EDEADLK]		A deadlock was detected or the value of thread specifies the calling thread.

     [EOPNOTSUPP]	The implementation detected that another caller is already waiting on thread.

     Additionally, the pthread_timedjoin_np() function will fail if:

     [ETIMEDOUT]	The specified absolute time passed while pthread_timedjoin_np() waited for thread exit.

SEE ALSO

     wait(2), pthread_create(3)

STANDARDS

     The pthread_join() function conforms to ISO/IEC 9945-1:1996 (``POSIX.1'').  The pthread_timedjoin_np() is a FreeBSD extension which first
     appeared in FreeBSD 6.1.

BSD
								 January 23, 2010							       BSD

pthread_join(3C)					   Standard C Library Functions 					  pthread_join(3C)

NAME

       pthread_join - wait for thread termination

SYNOPSIS

       cc -mt [ flag... ] file... -lpthread [ library... ]
       #include <pthread.h>

       int pthread_join(pthread_t thread, void **status);

DESCRIPTION

       The  pthread_join()  function  suspends	processing of the calling thread until the target thread completes. thread must be a member of the
       current process and it cannot be a detached thread. See pthread_create(3C).

       If two or more threads wait for the same thread to complete, all will suspend processing until the thread  has  terminated,  and  then  one
       thread will return successfully and the others will return with an error of ESRCH. The pthread_join() function will not block processing of
       the calling thread if the target thread has already terminated.

       If a pthread_join() call returns successfully with a non-null status argument, the value passed	to  pthread_exit(3C)  by  the  terminating
       thread will be placed in the location referenced by status.

       If  the	pthread_join()	calling  thread  is cancelled, then the target thread will remain joinable by pthread_join(). However, the calling
       thread may set up a cancellation cleanup handler on thread prior to  the  join  call,  which  may  detach  the  target  thread  by  calling
       pthread_detach(3C). See pthread_detach(3C) and pthread_cancel(3C).

RETURN VALUES

       If successful, pthread_join() returns 0. Otherwise, an error number is returned to indicate the error.

ERRORS

       EDEADLK	  A joining deadlock would occur, such as when a thread attempts to wait for itself.

       EINVAL	  The thread corresponding to the given thread ID is a detached thread.

       ESRCH	  No thread could be found corresponding to the given thread ID.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Standard			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       pthread_cancel(3C), pthread_create(3C), pthread_detach(3C), pthread_exit(3C), wait(3C), attributes(5), standards(5)

NOTES

       The pthread_join(3C) function must specify the thread ID for whose termination it will wait.

       Calling	pthread_join()	also  "detaches"  the  thread;	that is, pthread_join() includes the effect of the pthread_detach() function. If a
       thread were to be cancelled when blocked in pthread_join(), an explicit detach would have to be performed in the cancellation cleanup  han-
       dler. The pthread_detach() function exists primarily for this purpose.

SunOS 5.11							    23 Mar 2005 						  pthread_join(3C)