diff options
| author | David Thompson <dthompson2@worcester.edu> | 2018-12-12 09:20:10 -0500 |
|---|---|---|
| committer | David Thompson <dthompson2@worcester.edu> | 2018-12-12 09:20:10 -0500 |
| commit | f16fed3d50fd3d56deb46a3d4641a81460e389de (patch) | |
| tree | 71659ed643b65eadb17110b3f8f0c5d5cfdd3031 /manuals/chickadee/Channels.html | |
| parent | c4b418c2dcfba3c741f67058a51a3e490aa4b297 (diff) | |
Update Chickadee manual and home page for 0.3.0.
Better late than never!
Diffstat (limited to 'manuals/chickadee/Channels.html')
| -rw-r--r-- | manuals/chickadee/Channels.html | 146 |
1 files changed, 146 insertions, 0 deletions
diff --git a/manuals/chickadee/Channels.html b/manuals/chickadee/Channels.html new file mode 100644 index 0000000..f313c4f --- /dev/null +++ b/manuals/chickadee/Channels.html @@ -0,0 +1,146 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2017 David Thompson davet@gnu.org + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 +or any later version published by the Free Software Foundation; +with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU +Free Documentation License". + +A copy of the license is also available from the Free Software +Foundation Web site at http://www.gnu.org/licenses/fdl.html. + + +The document was typeset with +http://www.texinfo.org/ (GNU Texinfo). + --> +<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Channels (The Chickadee Game Toolkit)</title> + +<meta name="description" content="Channels (The Chickadee Game Toolkit)"> +<meta name="keywords" content="Channels (The Chickadee Game Toolkit)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html#Top" rel="start" title="Top"> +<link href="Index.html#Index" rel="index" title="Index"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Scripting.html#Scripting" rel="up" title="Scripting"> +<link href="Copying-This-Manual.html#Copying-This-Manual" rel="next" title="Copying This Manual"> +<link href="Tweening.html#Tweening" rel="prev" title="Tweening"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +blockquote.smallindentedblock {margin-right: 0em; font-size: smaller} +blockquote.smallquotation {font-size: smaller} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +div.smalldisplay {margin-left: 3.2em} +div.smallexample {margin-left: 3.2em} +div.smalllisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +pre.smalldisplay {font-family: inherit; font-size: smaller} +pre.smallexample {font-size: smaller} +pre.smallformat {font-family: inherit; font-size: smaller} +pre.smalllisp {font-size: smaller} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +@media (min-width: 1140px) { + body { + margin-left: 14rem; + margin-right: 4rem; + max-width: 52rem; + } +} + +@media (min-width: 800px) and (max-width: 1140px) { + body { + margin-left: 6rem; + margin-right: 4rem; + max-width: 52rem; + } +} + +@media (max-width: 800px) { + body { + margin: 1rem; + } +} + +--> +</style> +<link rel="stylesheet" type="text/css" href="https://dthompson.us/css/dthompson.css"> + + +</head> + +<body lang="en"> +<a name="Channels"></a> +<div class="header"> +<p> +Previous: <a href="Tweening.html#Tweening" accesskey="p" rel="prev">Tweening</a>, Up: <a href="Scripting.html#Scripting" accesskey="u" rel="up">Scripting</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index" rel="index">Index</a>]</p> +</div> +<hr> +<a name="Channels-1"></a> +<h4 class="subsection">2.4.4 Channels</h4> + +<p>Channels are a tool for communicating amongst different scripts. One +script can write a value to the channel and another can read from it. +Reading or writing to a channel suspends that script until there is +someone on the other end of the line to complete the transaction. +</p> +<p>Here’s a simplistic example: +</p> +<div class="example"> +<pre class="example">(define c (make-channel)) + +(script + (forever + (let ((item (channel-get c))) + (pk 'got item)))) + +(script + (channel-put c 'sword) + (channel-put c 'shield) + (channel-put c 'potion)) +</pre></div> + +<dl> +<dt><a name="index-make_002dchannel"></a>Procedure: <strong>make-channel</strong></dt> +<dd><p>Return a new channel +</p></dd></dl> + +<dl> +<dt><a name="index-channel_003f"></a>Procedure: <strong>channel?</strong> <em><var>obj</var></em></dt> +<dd><p>Return <code>#t</code> if <var>obj</var> is a channel. +</p></dd></dl> + +<dl> +<dt><a name="index-channel_002dget-1"></a>Procedure: <strong>channel-get</strong> <em><var>channel</var></em></dt> +<dd><p>Retrieve a value from <var>channel</var>. The current script suspends +until a value is available. +</p></dd></dl> + +<dl> +<dt><a name="index-channel_002dput"></a>Procedure: <strong>channel-put</strong> <em><var>channel</var> <var>data</var></em></dt> +<dd><p>Send <var>data</var> to <var>channel</var>. The current script suspends until +another script is available to retrieve the value. +</p></dd></dl> + + + + +</body> +</html> |