about summary refs log tree commit diff
diff options
context:
space:
mode:
authorMike Crowe <mac@mcrowe.com>2019-10-31 09:08:57 -0300
committerAdhemerval Zanella <adhemerval.zanella@linaro.org>2019-11-01 11:23:43 -0300
commit893bbdd0072fbf96808e66af04b970e5b39171fb (patch)
tree07abb3d085aa29c6503539739f000b84883e2ec8
parent22434b2f0360212d6c3ae775f425a0dbc97b2a4d (diff)
downloadglibc-893bbdd0072fbf96808e66af04b970e5b39171fb.tar.gz
glibc-893bbdd0072fbf96808e66af04b970e5b39171fb.tar.xz
glibc-893bbdd0072fbf96808e66af04b970e5b39171fb.zip
manual: Add documentation for pthread_tryjoin_np and pthread_timedjoin_np
Reviewed-by: Adhemerval Zanella <adhemerval.zanella@linaro.org>
-rw-r--r--manual/threads.texi26
1 files changed, 24 insertions, 2 deletions
diff --git a/manual/threads.texi b/manual/threads.texi
index bfe1e5b50b..c0b504dc1f 100644
--- a/manual/threads.texi
+++ b/manual/threads.texi
@@ -727,6 +727,30 @@ rather than @code{CLOCK_REALTIME}.  Currently, @var{clockid} must be either
 returned.
 @end deftypefun
 
+@comment pthread.h
+@comment GNU extension
+@deftypefun int pthread_tryjoin_np (pthread_t *@var{thread},
+				      void **@var{thread_return})
+@standards{GNU, pthread.h}
+@safety{@prelim{}@mtsafe{}@asunsafe{@asulock{}}@acunsafe{@aculock{}}}
+Behaves like @code{pthread_join} except that it will return @code{EBUSY}
+immediately if the thread specified by @var{thread} has not yet terminated.
+@end deftypefun
+
+@comment pthread.h
+@comment GNU extension
+@deftypefun int pthread_timedjoin_np (pthread_t *@var{thread},
+				      void **@var{thread_return},
+				      const struct timespec *@var{abstime})
+@standards{GNU, pthread.h}
+@safety{@prelim{}@mtsafe{}@asunsafe{@asulock{}}@acunsafe{@aculock{}}}
+Behaves like @code{pthread_tryjoin_np} except that it will block until the
+absolute time @var{abstime} measured against @code{CLOCK_REALTIME} is
+reached if the thread has not terminated by that time and return
+@code{EBUSY}. If @var{abstime} is equal to @code{NULL} then the function
+will wait forever in the same way as @code{pthread_join}.
+@end deftypefun
+
 @c FIXME these are undocumented:
 @c pthread_atfork
 @c pthread_attr_destroy
@@ -844,6 +868,4 @@ returned.
 @c pthread_spin_trylock
 @c pthread_spin_unlock
 @c pthread_testcancel
-@c pthread_timedjoin_np
-@c pthread_tryjoin_np
 @c pthread_yield