ossp-pkg/pth/pth.pod 1.147 -> 1.148
--- pth.pod 2001/07/12 07:20:04 1.147
+++ pth.pod 2001/08/06 17:35:38 1.148
@@ -705,9 +705,10 @@
=item C<PTH_ATTR_JOINABLE> (read-write> [C<int>]
-The thread detachment type, C<TRUE> indicates a joinable thread, C<FALSE>
-indicates a detached thread. When a the is detached after termination it is
-immediately kicked out of the system instead of inserted into the dead queue.
+The thread detachment type, C<TRUE> indicates a joinable thread,
+C<FALSE> indicates a detached thread. When a thread is detached,
+after termination it is immediately kicked out of the system instead of
+inserted into the dead queue.
=item C<PTH_ATTR_CANCEL_STATE> (read-write) [C<unsigned int>]
@@ -978,22 +979,24 @@
=item int B<pth_join>(pth_t I<tid>, void **I<value>);
-This joins the current thread with the thread specified via I<tid>. It first
-suspends the current thread until the I<tid> thread has terminated. Then it is
-awakened and stores the value of I<tid>'s pth_exit(3) call into *I<value> (if
-I<value> and not C<NULL>) and returns to the caller. A thread can be joined
-only when it was I<not> spawned with C<PTH_FLAG_NOJOIN>. A thread can only be
-joined once, i.e., after the pth_join(3) call the thread I<tid> is removed
-from the system.
+This joins the current thread with the thread specified via I<tid>.
+It first suspends the current thread until the I<tid> thread has
+terminated. Then it is awakened and stores the value of I<tid>'s
+pth_exit(3) call into *I<value> (if I<value> and not C<NULL>) and
+returns to the caller. A thread can be joined only when it has the
+attribute C<PTH_ATTR_JOINABLE> set to C<TRUE> (the default). A thread
+can only be joined once, i.e., after the pth_join(3) call the thread
+I<tid> is completely removed from the system.
=item void B<pth_exit>(void *I<value>);
-This terminates the current thread. Whether it's immediately removed from the
-system or inserted into the dead queue of the scheduler depends on its join
-type which was specified at spawning time. When it was spawned with
-C<PTH_FLAG_NOJOIN> it's immediately removed and I<value> is ignored.
-Else the thread is inserted into the dead queue and I<value> remembered
-for a pth_join(3) call by another thread.
+This terminates the current thread. Whether it's immediately removed
+from the system or inserted into the dead queue of the scheduler depends
+on its join type which was specified at spawning time. If it has the
+attribute C<PTH_ATTR_JOINABLE> set to C<FALSE>, it's immediately removed
+and I<value> is ignored. Else the thread is inserted into the dead queue
+and I<value> remembered for a subsequent pth_join(3) call by another
+thread.
=back
|
|
