リナックスコマンド

pthread_joinのヘルプ・マニュアル

日本語 英語

• help
• man

pthread_join --help

man pthread_join

PTHREAD_JOIN(3) PTHREAD_JOIN(3) 名前 pthread_join - 別のスレッドの終了を待つ 書式 #include int pthread_join(pthread_t th, void **thread_return); 説明 pthread_join は、呼び出しスレッドの実行を停止し、 th で指定したスレッド が pthread_exit(3) を呼び出して終了するか、取り消しされて終了するのを待 つ。 thread_return が NULL でないときには、 th の返り値が thread_return で指 し示される領域に格納される。 th の返り値は、 pthread_exit(3) に与えられ た引数、または PTHREAD_CANCELED( th が取り消しされた場合 ) である。 合 流 (join) されるスレッド th は、合流可能 (joinable) な状態でなければ ならない。すなわち、 pthread_detach(3) を使用してデタッチ (detach) され て いたり、 pthread_create(3) で属性 PTHREAD_CREATE_DETACHED を与えられ ていたりしてはならない。 合流可能なスレッドが終了しても、別のスレッドがそのスレッ ド に 対 し て pthread_join を呼び出すまでは、そのメモリ資源 (スレッドディスクリプタと スタック) は解放されない。したがって、メモリリークを防ぐためには、合 流 可能なスレッドそれぞれに対して pthread_join を 1 回ずつ呼び出さなければ ならない。 あるスレッドの終了を待つことができるスレッドは高々 1 つである。すでに別 の スレッドが終了を待っているスレッド th に対して pthread_join を呼び出 した場合、エラーが返る。 取り消し pthread_join は取り消しポイントである。スレッドが pthread_join で停止し て いるときに取り消しされると、直ちに実行が再開されてスレッド th が終了 するのを待つことなく取り消しが実行される。取り消しが pthread_join で 起 こった場合には、スレッド th は合流されずに残ることになる。 返り値 成 功 すると、 th の返り値が thread_return で指し示された領域に格納され 、0 が返る。エラーの場合、非 0 のエラーコードが返る。 エラー ESRCH th で指定された ID に対応するスレッドが見つからなかった。 EINVAL th で指定されたスレッドはすでにデタッチされている。 EINVAL すでに別のスレッドがスレッド th の終了を待っている。 EDEADLK 引数 th が呼び出しスレッドを指している。 著者 Xavier Leroy 関連項目 pthread_exit(3), pthread_detach(3), pthread_create(3), pthread_attr_setdetachstate(3), pthread_cleanup_push(3), pthread_key_create(3). LinuxThreads PTHREAD_JOIN(3)

PTHREAD_JOIN(3) Linux Programmer’s Manual PTHREAD_JOIN(3) NAME pthread_join - join with a terminated thread SYNOPSIS #include int pthread_join(pthread_t thread, void **retval); Compile and link with -pthread. DESCRIPTION The pthread_join() function waits for the thread specified by thread to terminate. If that thread has already terminated, then pthread_join() returns immediately. The thread specified by thread must be joinable. If retval is not NULL, then pthread_join() copies the exit status of the target thread (i.e., the value that the target thread supplied to pthread_exit(3)) into the location pointed to by *retval. If the tar- get thread was canceled, then PTHREAD_CANCELED is placed in *retval. If multiple threads simultaneously try to join with the same thread, the results are undefined. If the thread calling pthread_join() is canceled, then the target thread will remain joinable (i.e., it will not be detached). RETURN VALUE On success, pthread_join() returns 0; on error, it returns an error number. ERRORS EDEADLK A deadlock was detected (e.g., two threads tried to join with each other); or thread specifies the calling thread. EINVAL thread is not a joinable thread. EINVAL Another thread is already waiting to join with this thread. ESRCH No thread with the ID thread could be found. CONFORMING TO POSIX.1-2001. NOTES After a successful call to pthread_create(), the caller is guaranteed that the target thread has terminated. Joining with a thread that has previously been joined results in unde- fined behavior. Failure to join with a thread that is joinable (i.e., one that is not detached), produces a "zombie thread". Avoid doing this, since each zombie thread consumes some system resources, and when enough zombie threads have accumulated, it will no longer be possible to create new threads (or processes). There is no pthreads analog of waitpid(-1, &status, 0), that is, "join with any terminated thread". If you believe you need this functional- ity, you probably need to rethink your application design. All of the threads in a process are peers: any thread can join with any other thread in the process. EXAMPLE See pthread_create(3). SEE ALSO pthread_cancel(3), pthread_create(3), pthread_detach(3), pthread_exit(3), pthread_tryjoin_np(3), pthreads(7) COLOPHON This page is part of release 3.22 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://www.kernel.org/doc/man-pages/. Linux 2008-11-27 PTHREAD_JOIN(3)