Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

pthread_timedjoin_np(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(3T)														  pthread_join(3T)

NAME
pthread_join() - wait for the termination of a specified thread SYNOPSIS
PARAMETERS
thread Thread whose termination is awaited by the caller. value_ptr Pointer to the location where the exit status of thread is returned. DESCRIPTION
The function waits for the termination of the target thread. If the target thread has already terminated, this function returns immedi- ately. Only threads created with a detachstate attribute value of may be specified in the target thread parameter. On successful return from the value_ptr argument, if it is not a null pointer, will contain the value passed to by the terminating thread. When a call returns successfully, the caller is guaranteed the target thread has terminated. If more than one thread calls for the same target thread, one thread is guaranteed to return successfully. Undefined behavior results for other callers specifying the same thread. If the thread calling is canceled, the target thread shall not be joined. The exit status of the target thread will remain available for another thread to call If the target thread was canceled, its exit status is It is unspecified whether a thread that has exited, but remains unjoined, counts against the limit. RETURN VALUE
Upon successful completion, returns zero. Otherwise, an error number is returned to indicate the error (the variable is not set). ERRORS
If any of the following occur, the function returns the corresponding error number: [EINVAL] The value specified by thread does not refer to a joinable thread. [ESRCH] No thread could be found corresponding to thread. For each of the following conditions, if the condition is detected, the function returns the corresponding error number: [EDEADLK] This operation would result in process deadlock or thread specifies the calling thread. AUTHOR
was derived from the IEEE POSIX P1003.1c standard. SEE ALSO
pthread_create(3T), wait(2). STANDARDS CONFORMANCE
Pthread Library pthread_join(3T)
Man Page