Linux and UNIX Man Pages

Test Your Knowledge in Computers #653
Difficulty: Easy
Rocky Raccoon is the mascot of MINIX 3.
True or False?
Linux & Unix Commands - Search Man Pages

pthread_join(3c) [opensolaris man page]

pthread_join(3C)					   Standard C Library Functions 					  pthread_join(3C)

pthread_join - wait for thread termination SYNOPSIS
cc -mt [ flag... ] file... -lpthread [ library... ] #include <pthread.h> int pthread_join(pthread_t thread, void **status); DESCRIPTION
The pthread_join() function suspends processing of the calling thread until the target thread completes. thread must be a member of the current process and it cannot be a detached thread. See pthread_create(3C). If two or more threads wait for the same thread to complete, all will suspend processing until the thread has terminated, and then one thread will return successfully and the others will return with an error of ESRCH. The pthread_join() function will not block processing of the calling thread if the target thread has already terminated. If a pthread_join() call returns successfully with a non-null status argument, the value passed to pthread_exit(3C) by the terminating thread will be placed in the location referenced by status. If the pthread_join() calling thread is cancelled, then the target thread will remain joinable by pthread_join(). However, the calling thread may set up a cancellation cleanup handler on thread prior to the join call, which may detach the target thread by calling pthread_detach(3C). See pthread_detach(3C) and pthread_cancel(3C). RETURN VALUES
If successful, pthread_join() returns 0. Otherwise, an error number is returned to indicate the error. ERRORS
EDEADLK A joining deadlock would occur, such as when a thread attempts to wait for itself. EINVAL The thread corresponding to the given thread ID is a detached thread. ESRCH No thread could be found corresponding to the given thread ID. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Standard | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe | +-----------------------------+-----------------------------+ SEE ALSO
pthread_cancel(3C), pthread_create(3C), pthread_detach(3C), pthread_exit(3C), wait(3C), attributes(5), standards(5) NOTES
The pthread_join(3C) function must specify the thread ID for whose termination it will wait. Calling pthread_join() also "detaches" the thread; that is, pthread_join() includes the effect of the pthread_detach() function. If a thread were to be cancelled when blocked in pthread_join(), an explicit detach would have to be performed in the cancellation cleanup han- dler. The pthread_detach() function exists primarily for this purpose. SunOS 5.11 23 Mar 2005 pthread_join(3C)

Check Out this Related Man Page

pthread_join(3) 					     Library Functions Manual						   pthread_join(3)

pthread_join - Causes the calling thread to wait for the termination of the specified thread. LIBRARY
DECthreads POSIX 1003.1c Library ( 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
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)

Featured Tech Videos