diff options
author | Andy Wingo <wingo@pobox.com> | 2016-10-31 22:11:01 +0100 |
---|---|---|
committer | Andy Wingo <wingo@pobox.com> | 2016-10-31 22:11:01 +0100 |
commit | a7114ced5f062a92d34b07f2fcc5a05e8612482a (patch) | |
tree | d84b8b064fe75731a686d9c4bbb72b24de1f2e41 /doc/ref/api-scheduling.texi | |
parent | 6bf9c6541937469f32228008634307824a902ecb (diff) | |
download | guile-a7114ced5f062a92d34b07f2fcc5a05e8612482a.tar.gz |
cancel-thread can take arguments
* doc/ref/api-scheduling.texi (Threads):
* module/ice-9/threads.scm (cancel-thread): Additional args to
cancel-thread will be returned by the thread.
Diffstat (limited to 'doc/ref/api-scheduling.texi')
-rw-r--r-- | doc/ref/api-scheduling.texi | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/ref/api-scheduling.texi b/doc/ref/api-scheduling.texi index 45b5315ce..564d43fe0 100644 --- a/doc/ref/api-scheduling.texi +++ b/doc/ref/api-scheduling.texi @@ -112,12 +112,13 @@ If one or more threads are waiting to execute, calling yield forces an immediate context switch to one of them. Otherwise, yield has no effect. @end deffn -@deffn {Scheme Procedure} cancel-thread thread +@deffn {Scheme Procedure} cancel-thread thread . values @deffnx {C Function} scm_cancel_thread (thread) Asynchronously interrupt @var{thread} and ask it to terminate. @code{dynamic-wind} post thunks will run, but throw handlers will not. If @var{thread} has already terminated or been signaled to terminate, -this function is a no-op. +this function is a no-op. Calling @code{join-thread} on the thread will +return the given @var{values}, if the cancel succeeded. Under this hood, thread cancellation uses @code{system-async-mark} and @code{abort-to-prompt}. @xref{Asyncs} for more on asynchronous |