PTHREAD_JOIN(3) BSD Programmer's Manual PTHREAD_JOIN(3)NAMEpthread_join - wait until a specified thread exits
SYNOPSIS
#include <pthread.h>
int
pthread_join(pthread_t tid, void **value);
DESCRIPTION
This interface is defined by IEEE Std1003.1c (``POSIX'').
The pthread_join() function blocks execution of the calling thread until
the thread specified by tid terminates. If the thread specified by tid
is already terminated, pthread_join() will return immediately.
Upon completion of a successful call to pthread_join(), value will con-
tain the exit status of the target thread passed to pthread_exit(). If
the target thread was canceled a value of PTHREAD_CANCELED is returned.
Care should be taken to insure that the value of PTHREAD_CANCELED is not
returned in a call to pthread_exit(2). If value is NULL no exit status
is returned.
RETURN VALUES
The pthread_join() function returns 0 upon successful completion. If an
error occurs, a non-zero error value is returned.
ERRORS
The pthread_join function may fail and return one of the following er-
rors:
[EDEADLK] A call to to pthread_join() was made with tid specifying
the calling thread.
[EINVAL] The value specified by tid does not refer to a joinable
thread.
[ESRCH] No thread could be found corresponding to the specified
thread ID tid.
SEE ALSOpthreads(3), pthread_create(3), pthread_exit(3), pthread_detach(3)STANDARDS
The pthread_join function conforms to IEEE Std1003.1c (``POSIX'').
HISTORY
The pthread_join function first appeared in BSD/OS 3.0.
4th Berkeley Distribution June 3, 1996 1
