<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Control.Concurrent.Chan</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Control-Concurrent-Chan.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Control-Concurrent-Chan.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">base-4.3.1.0: Basic libraries</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>non-portable (concurrency)</td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Maintainer</th><td>libraries@haskell.org</td></tr></table><p class="caption">Control.Concurrent.Chan</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">The <code><a href="Control-Concurrent-Chan.html#t:Chan">Chan</a></code> type
</a></li><li><a href="#g:2">Operations
</a></li><li><a href="#g:3">Stream interface
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Unbounded channels.
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:Chan">Chan</a> a</li><li class="src short"><a href="#v:newChan">newChan</a> :: <a href="System-IO.html#t:IO">IO</a> (<a href="Control-Concurrent-Chan.html#t:Chan">Chan</a> a)</li><li class="src short"><a href="#v:writeChan">writeChan</a> :: <a href="Control-Concurrent-Chan.html#t:Chan">Chan</a> a -> a -> <a href="System-IO.html#t:IO">IO</a> <a href="../ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:readChan">readChan</a> :: <a href="Control-Concurrent-Chan.html#t:Chan">Chan</a> a -> <a href="System-IO.html#t:IO">IO</a> a</li><li class="src short"><a href="#v:dupChan">dupChan</a> :: <a href="Control-Concurrent-Chan.html#t:Chan">Chan</a> a -> <a href="System-IO.html#t:IO">IO</a> (<a href="Control-Concurrent-Chan.html#t:Chan">Chan</a> a)</li><li class="src short"><a href="#v:unGetChan">unGetChan</a> :: <a href="Control-Concurrent-Chan.html#t:Chan">Chan</a> a -> a -> <a href="System-IO.html#t:IO">IO</a> <a href="../ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:isEmptyChan">isEmptyChan</a> :: <a href="Control-Concurrent-Chan.html#t:Chan">Chan</a> a -> <a href="System-IO.html#t:IO">IO</a> <a href="Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:getChanContents">getChanContents</a> :: <a href="Control-Concurrent-Chan.html#t:Chan">Chan</a> a -> <a href="System-IO.html#t:IO">IO</a> [a]</li><li class="src short"><a href="#v:writeList2Chan">writeList2Chan</a> :: <a href="Control-Concurrent-Chan.html#t:Chan">Chan</a> a -> [a] -> <a href="System-IO.html#t:IO">IO</a> <a href="../ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li></ul></div><div id="interface"><h1 id="g:1">The <code><a href="Control-Concurrent-Chan.html#t:Chan">Chan</a></code> type
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Chan" class="def">Chan</a> a <a href="src/Control-Concurrent-Chan.html#Chan" class="link">Source</a></p><div class="doc"><p><code><a href="Control-Concurrent-Chan.html#t:Chan">Chan</a></code> is an abstract type representing an unbounded FIFO channel.
</p></div><div class="subs instances"><p id="control.i:Chan" class="caption collapser" onclick="toggleSection('i:Chan')">Instances</p><div id="section.i:Chan" class="show"><table><tr><td class="src"><a href="Data-Typeable.html#t:Typeable1">Typeable1</a> <a href="Control-Concurrent-Chan.html#t:Chan">Chan</a></td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:2">Operations
</h1><div class="top"><p class="src"><a name="v:newChan" class="def">newChan</a> :: <a href="System-IO.html#t:IO">IO</a> (<a href="Control-Concurrent-Chan.html#t:Chan">Chan</a> a)<a href="src/Control-Concurrent-Chan.html#newChan" class="link">Source</a></p><div class="doc"><p>Build and returns a new instance of <code><a href="Control-Concurrent-Chan.html#t:Chan">Chan</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:writeChan" class="def">writeChan</a> :: <a href="Control-Concurrent-Chan.html#t:Chan">Chan</a> a -> a -> <a href="System-IO.html#t:IO">IO</a> <a href="../ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/Control-Concurrent-Chan.html#writeChan" class="link">Source</a></p><div class="doc"><p>Write a value to a <code><a href="Control-Concurrent-Chan.html#t:Chan">Chan</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:readChan" class="def">readChan</a> :: <a href="Control-Concurrent-Chan.html#t:Chan">Chan</a> a -> <a href="System-IO.html#t:IO">IO</a> a<a href="src/Control-Concurrent-Chan.html#readChan" class="link">Source</a></p><div class="doc"><p>Read the next value from the <code><a href="Control-Concurrent-Chan.html#t:Chan">Chan</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:dupChan" class="def">dupChan</a> :: <a href="Control-Concurrent-Chan.html#t:Chan">Chan</a> a -> <a href="System-IO.html#t:IO">IO</a> (<a href="Control-Concurrent-Chan.html#t:Chan">Chan</a> a)<a href="src/Control-Concurrent-Chan.html#dupChan" class="link">Source</a></p><div class="doc"><p>Duplicate a <code><a href="Control-Concurrent-Chan.html#t:Chan">Chan</a></code>: the duplicate channel begins empty, but data written to
either channel from then on will be available from both. Hence this creates
a kind of broadcast channel, where data written by anyone is seen by
everyone else.
</p></div></div><div class="top"><p class="src"><a name="v:unGetChan" class="def">unGetChan</a> :: <a href="Control-Concurrent-Chan.html#t:Chan">Chan</a> a -> a -> <a href="System-IO.html#t:IO">IO</a> <a href="../ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/Control-Concurrent-Chan.html#unGetChan" class="link">Source</a></p><div class="doc"><p>Put a data item back onto a channel, where it will be the next item read.
</p></div></div><div class="top"><p class="src"><a name="v:isEmptyChan" class="def">isEmptyChan</a> :: <a href="Control-Concurrent-Chan.html#t:Chan">Chan</a> a -> <a href="System-IO.html#t:IO">IO</a> <a href="Data-Bool.html#t:Bool">Bool</a><a href="src/Control-Concurrent-Chan.html#isEmptyChan" class="link">Source</a></p><div class="doc"><p>Returns <code><a href="Data-Bool.html#v:True">True</a></code> if the supplied <code><a href="Control-Concurrent-Chan.html#t:Chan">Chan</a></code> is empty.
</p></div></div><h1 id="g:3">Stream interface
</h1><div class="top"><p class="src"><a name="v:getChanContents" class="def">getChanContents</a> :: <a href="Control-Concurrent-Chan.html#t:Chan">Chan</a> a -> <a href="System-IO.html#t:IO">IO</a> [a]<a href="src/Control-Concurrent-Chan.html#getChanContents" class="link">Source</a></p><div class="doc"><p>Return a lazy list representing the contents of the supplied
<code><a href="Control-Concurrent-Chan.html#t:Chan">Chan</a></code>, much like <code>System.IO.hGetContents</code>.
</p></div></div><div class="top"><p class="src"><a name="v:writeList2Chan" class="def">writeList2Chan</a> :: <a href="Control-Concurrent-Chan.html#t:Chan">Chan</a> a -> [a] -> <a href="System-IO.html#t:IO">IO</a> <a href="../ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/Control-Concurrent-Chan.html#writeList2Chan" class="link">Source</a></p><div class="doc"><p>Write an entire list of items to a <code><a href="Control-Concurrent-Chan.html#t:Chan">Chan</a></code>.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
