NAME
pthread_join —
wait for thread termination
SYNOPSIS
#include <pthread.h> int pthread_join(pthread_t thread, void **value_ptr);
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(3) by the terminating thread is made available 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 canceled, then the target thread will not be detached.
It is unspecified whether a thread that has exited but remains unjoined counts against _POSIX_THREAD_THREADS_MAX.
RETURN VALUE
If successful, the pthread_join() function returns zero. Otherwise, an error number is returned to indicate the error.
ERRORS
The pthread_join() function 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.
The pthread_join() function may fail if:
- [EDEADLK]
- A deadlock was detected or the value of thread specifies the calling thread.
The pthread_join() function will not return an error code of [EINTR].
EXAMPLES
None.
APPLICATION USAGE
None.
FUTURE DIRECTIONS
None.
SEE ALSO
DERIVATION
Derived from the POSIX Threads Extension (1003.1c-1995)