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

Check Out this Related Man Page

PTHREAD_JOIN(3) 					     Library Functions Manual						   PTHREAD_JOIN(3)

NAME

       pthread_join - wait for termination of another thread

SYNOPSIS

       #include <pthread.h>

       int pthread_join(pthread_t th, void **thread_return);

DESCRIPTION

       pthread_join  suspends  the execution of the calling thread until the thread identified by th terminates, either by calling pthread_exit(3)
       or by being cancelled.

       If thread_return is not NULL, the return value of th is stored in the location pointed to by thread_return.  The  return  value	of  th	is
       either the argument it gave to pthread_exit(3), or PTHREAD_CANCELED if th was cancelled.

       The  joined  thread th must be in the joinable state: it must not have been detached using pthread_detach(3) or the PTHREAD_CREATE_DETACHED
       attribute to pthread_create(3).

       When a joinable thread terminates, its memory resources (thread descriptor and stack) are not deallocated  until  another  thread  performs
       pthread_join on it. Therefore, pthread_join must be called once for each joinable thread created to avoid memory leaks.

       At  most  one thread can wait for the termination of a given thread. Calling pthread_join on a thread th on which another thread is already
       waiting for termination returns an error.

CANCELLATION

       pthread_join is a cancellation point. If a thread is canceled while suspended in pthread_join, the thread execution resumes immediately and
       the  cancellation  is  executed	without  waiting for the th thread to terminate. If cancellation occurs during pthread_join, the th thread
       remains not joined.

RETURN VALUE

       On success, the return value of th is stored in the location pointed to by thread_return, and 0 is returned. On	error,	a  non-zero  error
       code is returned.

ERRORS

       ESRCH  No thread could be found corresponding to that specified by th.

       EINVAL The th thread has been detached.

       EINVAL Another thread is already waiting on termination of th.

       EDEADLK
	      The th argument refers to the calling thread.

AUTHOR

       Xavier Leroy <Xavier.Leroy@inria.fr>

SEE ALSO

       pthread_exit(3), pthread_detach(3), pthread_create(3), pthread_attr_setdetachstate(3), pthread_cleanup_push(3), pthread_key_create(3).

								   LinuxThreads 						   PTHREAD_JOIN(3)

Linux and UNIX Man Pages

pthread_join(3) [freebsd man page]

Check Out this Related Man Page