aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNIIBE Yutaka <gniibe@fsij.org>2015-09-09 17:06:51 +0900
committerNIIBE Yutaka <gniibe@fsij.org>2015-09-09 17:06:51 +0900
commitacd4460a6ee0f7caa1d7871acd51cdcf6bb4264c (patch)
tree22bd4ea890208939fc4a5d38938e89ac02627674 /doc
parent79b13fb4a9f8c1e7d4158b19870a396b05144061 (diff)
Update API doc
Diffstat (limited to 'doc')
-rw-r--r--doc/chopstx-api.texi12
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/chopstx-api.texi b/doc/chopstx-api.texi
index 8de6a24..6ccf6d8 100644
--- a/doc/chopstx-api.texi
+++ b/doc/chopstx-api.texi
@@ -30,7 +30,7 @@ and it runs with that priority until this routine will is called.
@var{arg}: Argument to the thread entry function
-Create a thread.
+Create a thread. Returns thread ID.
@end deftypefun
@subheading chopstx_usec_wait_var
@@ -199,3 +199,13 @@ No return value. If the thread is canceled, this function
does not return.
@end deftypefun
+@subheading chopstx_setcancelstate
+@anchor{chopstx_setcancelstate}
+@deftypefun {int} {chopstx_setcancelstate} (int @var{cancel_disable})
+@var{cancel_disable}: 0 to enable cancelation, otherwise disabled.
+
+Calling chopstx_setcancelstate sets cancelability state.
+
+Returns old state which is 0 when it was enabled.
+@end deftypefun
+