Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

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 - Causes the calling thread to wait for the termination of the specified thread. LIBRARY
DECthreads POSIX 1003.1c Library (libpthread.so) SYNOPSIS
#include <pthread.h> int pthread_join( pthread_t thread, void **value_ptr); STANDARDS
Interfaces documented on this reference page conform to industry standards as follows: IEEE Std 1003.1c-1995, POSIX System Application Program Interface PARAMETERS
Thread whose termination is awaited by the calling routine. Return value of the terminating thread (when that thread either calls pthread_exit(3) or returns from its start routine). DESCRIPTION
This routine suspends execution of the calling thread until the specified target thread thread terminates. On return from a successful pthread_join(3) call with a non-NULL value_ptr argument, the value passed to pthread_exit(3) is returned in the location referenced by value_ptr, and the terminating thread is detached. If more than one thread attempts to join with the same thread, the results are unpredictable. A call to pthread_join(3) returns after the target thread terminates. The pthread_join(3) routine is a deferred cancelation point: the target thread will not be detached if the thread blocked in pthread_join(3) is canceled. If a thread calls this routine and specifies its own pthread_t, a deadlock can result. The pthread_join(3) (or pthread_detach(3)) routine should eventually be called for every thread that is created with the detachstate attribute of its thread attributes object set to PTHREAD_CREATE_JOINABLE, so that storage associated with the thread can be reclaimed. RETURN VALUES
If an error condition occurs, this routine returns an integer value indicating the type of error. Possible return values are as follows: Successful completion. The value specified by thread does not refer to a joinable thread. The value specified by thread does not refer to an existing thread ID. A deadlock was detected, or thread specifies the calling thread. ERRORS
None RELATED INFORMATION
Functions: pthread_cancel(3), pthread_create(3), pthread_detach(3), pthread_exit(3) Manuals: Guide to DECthreads and Programmer's Guide delim off pthread_join(3)
Man Page

Featured Tech Videos