thr_join(3T)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUES | ERRORS | ATTRIBUTES | SEE ALSO | NOTES

NAME

thr_join- wait for thread termination

SYNOPSIS

cc - mt [ flag... ] file...[ library... ]

#include <thread.h> 

int thr_join(thread_t thread, thread_t *departed, void **status);

DESCRIPTION

The thr_join() functions suspend 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 or daemon thread. See thr_create(3T).

Several threads cannot wait for the same thread to complete; one thread will complete successfully and the others will terminate with an error of ESRCH. thr_join() will not block processing of the calling thread if the target thread has already terminated.

thr_join() returns successfully when the target thread terminates.

If a thr_join() call returns successfully with a non-null status argument, the value passed to thr_exit(3T) by the terminating thread will be placed in the location referenced by status.

If the target thread ID is 0, thr_join() waits for any undetached thread in the process to terminate.

If departed is not NULL, it points to a location that is set to the ID of the terminated thread if thr_join() returns successfully.

RETURN VALUES

If successful, thr_join() returns 0. Otherwise, an error number is returned to indicate the error.

ERRORS

ESRCH

No undetached thread could be found corresponding to that specified by the given thread ID.

EDEADLK

A recursive deadlock was detected, the value of thread specifies the calling thread. See NOTES.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
MT-Level	MT-Safe

SEE ALSO

wait(2), thr_create(3T), thr_exit(3T), attributes(5), standards(5)

NOTES

Using thr_join(3T) in the following syntax,

while (thr_join(NULL, NULL, NULL) == 0); 

will wait for the termination of all other undetached and non-daemon threads; after which, EDEADLK will be returned.

SunOS 5.7  Last Revised 9 May 1998

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUES | ERRORS | ATTRIBUTES | SEE ALSO | NOTES