pthread_join man page on FreeBSD

Man page or keyword search:  
man Server   9747 pages
apropos Keyword Search (all sections)
Output format
FreeBSD logo
[printable version]

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 tar‐
     get thread are undefined.	If the thread calling pthread_join() is can‐
     celled, 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 indicate
     the error.

ERRORS
     The pthread_join() and pthread_timedjoin_np() functions will fail if:

     [EINVAL]		The implementation has detected that the value speci‐
			fied by thread does not refer to a joinable thread.

     [ESRCH]		No thread could be found corresponding to that speci‐
			fied by the given thread ID, thread.

     [EDEADLK]		A deadlock was detected or the value of thread speci‐
			fies 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
[top]

List of man pages available for FreeBSD

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
...................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net