summaryrefslogtreecommitdiff
path: root/doc/api.texi
diff options
context:
space:
mode:
authorDavid Thompson <dthompson2@worcester.edu>2018-11-29 16:26:48 -0500
committerDavid Thompson <dthompson2@worcester.edu>2018-11-29 16:30:55 -0500
commitfb8f3bcd6cec02243098ec60838ce0a7778aff38 (patch)
tree85fadec487084f4c8bfe7ff9c6c31a6e6f8ef111 /doc/api.texi
parent1afab11233de20272bdc029e70a5e1dcfd17218e (diff)
scripting: channel: Add channel-get! and channel-put! procedures.
* chickadee/scripting/channel.scm (channel-get!, channel-put!): New procedures. * doc/api.texi [Channels]: Add docs.
Diffstat (limited to 'doc/api.texi')
-rw-r--r--doc/api.texi17
1 files changed, 13 insertions, 4 deletions
diff --git a/doc/api.texi b/doc/api.texi
index 4c34cf4..c79af20 100644
--- a/doc/api.texi
+++ b/doc/api.texi
@@ -1934,10 +1934,6 @@ procedure @var{handler}.
Wait @var{duration} before resuming the current script.
@end deffn
-@deffn {Procedure} channel-get @var{channel}
-Wait for a message from @var{channel}.
-@end deffn
-
@deffn {Syntax} forever @var{body} @dots{}
Evaluate @var{body} in an endless loop.
@end deffn
@@ -2014,3 +2010,16 @@ until a value is available.
Send @var{data} to @var{channel}. The current script suspends until
another script is available to retrieve the value.
@end deffn
+
+A low-level API also exists for using channels outside of a script via
+callback procedures:
+
+@deffn {Procedure} channel-get! @var{channel} @var{proc}
+Asynchronously retrieve a value from @var{channel} and call @var{proc}
+with that value.
+@end deffn
+
+@deffn {Procedure} channel-put! @var{channel} @var{data} [@var{thunk}]
+Asynchronously send @var{data} to @var{channel} and call @var{thunk}
+after it has been received.
+@end deffn