Sophie: ghc-0:6.10.4-1mdv2010.0 i586

ghc-6.10.4-1mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--Rendered using the Haskell Html Library v0.2-->
<HTML
><HEAD
><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
><TITLE
>Control.Concurrent.STM.TChan</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock-util.js" TYPE="text/javascript"
></SCRIPT
><SCRIPT TYPE="text/javascript"
>window.onload = function () {setSynopsis("mini_Control-Concurrent-STM-TChan.html")};</SCRIPT
></HEAD
><BODY
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="topbar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
></TD
><TD CLASS="title"
>stm-2.1.1.2: Software Transactional Memory</TD
><TD CLASS="topbut"
><A HREF="index.html"
>Contents</A
></TD
><TD CLASS="topbut"
><A HREF="doc-index.html"
>Index</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="modulebar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><FONT SIZE="6"
>Control.Concurrent.STM.TChan</FONT
></TD
><TD ALIGN="right"
><TABLE CLASS="narrow" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="infohead"
>Portability</TD
><TD CLASS="infoval"
>non-portable (requires STM)</TD
></TR
><TR
><TD CLASS="infohead"
>Stability</TD
><TD CLASS="infoval"
>experimental</TD
></TR
><TR
><TD CLASS="infohead"
>Maintainer</TD
><TD CLASS="infoval"
>libraries@haskell.org</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="section4"
><B
>Contents</B
></TD
></TR
><TR
><TD
><DL
><DT
><A HREF="#1"
>TChans
</A
></DT
></DL
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
>TChan: Transactional channels
 (GHC only)
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Synopsis</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3ATChan"
>TChan</A
> a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AnewTChan"
>newTChan</A
> ::  <A HREF="../base/GHC-Conc.html#t%3ASTM"
>STM</A
> (<A HREF="Control-Concurrent-STM-TChan.html#t%3ATChan"
>TChan</A
> a)</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AnewTChanIO"
>newTChanIO</A
> ::  <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="Control-Concurrent-STM-TChan.html#t%3ATChan"
>TChan</A
> a)</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AreadTChan"
>readTChan</A
> ::  <A HREF="Control-Concurrent-STM-TChan.html#t%3ATChan"
>TChan</A
> a -&gt; <A HREF="../base/GHC-Conc.html#t%3ASTM"
>STM</A
> a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AwriteTChan"
>writeTChan</A
> ::  <A HREF="Control-Concurrent-STM-TChan.html#t%3ATChan"
>TChan</A
> a -&gt; a -&gt; <A HREF="../base/GHC-Conc.html#t%3ASTM"
>STM</A
> <A HREF="../ghc-prim/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AdupTChan"
>dupTChan</A
> ::  <A HREF="Control-Concurrent-STM-TChan.html#t%3ATChan"
>TChan</A
> a -&gt; <A HREF="../base/GHC-Conc.html#t%3ASTM"
>STM</A
> (<A HREF="Control-Concurrent-STM-TChan.html#t%3ATChan"
>TChan</A
> a)</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AunGetTChan"
>unGetTChan</A
> ::  <A HREF="Control-Concurrent-STM-TChan.html#t%3ATChan"
>TChan</A
> a -&gt; a -&gt; <A HREF="../base/GHC-Conc.html#t%3ASTM"
>STM</A
> <A HREF="../ghc-prim/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AisEmptyTChan"
>isEmptyTChan</A
> ::  <A HREF="Control-Concurrent-STM-TChan.html#t%3ATChan"
>TChan</A
> a -&gt; <A HREF="../base/GHC-Conc.html#t%3ASTM"
>STM</A
> <A HREF="../ghc-prim/GHC-Bool.html#t%3ABool"
>Bool</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="1"
><A NAME="1"
>TChans
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:TChan"
><A NAME="t%3ATChan"
></A
></A
><B
>TChan</B
> a </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
><TT
><A HREF="Control-Concurrent-STM-TChan.html#t%3ATChan"
>TChan</A
></TT
> is an abstract type representing an unbounded FIFO channel.
</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:newTChan"
><A NAME="v%3AnewTChan"
></A
></A
><B
>newTChan</B
> ::  <A HREF="../base/GHC-Conc.html#t%3ASTM"
>STM</A
> (<A HREF="Control-Concurrent-STM-TChan.html#t%3ATChan"
>TChan</A
> a)</TD
></TR
><TR
><TD CLASS="doc"
>Build and returns a new instance of <TT
><A HREF="Control-Concurrent-STM-TChan.html#t%3ATChan"
>TChan</A
></TT
>
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:newTChanIO"
><A NAME="v%3AnewTChanIO"
></A
></A
><B
>newTChanIO</B
> ::  <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="Control-Concurrent-STM-TChan.html#t%3ATChan"
>TChan</A
> a)</TD
></TR
><TR
><TD CLASS="doc"
><TT
>IO</TT
> version of <TT
><A HREF="Control-Concurrent-STM-TChan.html#v%3AnewTChan"
>newTChan</A
></TT
>.  This is useful for creating top-level
 <TT
><A HREF="Control-Concurrent-STM-TChan.html#t%3ATChan"
>TChan</A
></TT
>s using System.IO.Unsafe.unsafePerformIO, because using
 <TT
><A HREF="../base/GHC-Conc.html#v%3Aatomically"
>atomically</A
></TT
> inside System.IO.Unsafe.unsafePerformIO isn't
 possible.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:readTChan"
><A NAME="v%3AreadTChan"
></A
></A
><B
>readTChan</B
> ::  <A HREF="Control-Concurrent-STM-TChan.html#t%3ATChan"
>TChan</A
> a -&gt; <A HREF="../base/GHC-Conc.html#t%3ASTM"
>STM</A
> a</TD
></TR
><TR
><TD CLASS="doc"
>Read the next value from the <TT
><A HREF="Control-Concurrent-STM-TChan.html#t%3ATChan"
>TChan</A
></TT
>.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:writeTChan"
><A NAME="v%3AwriteTChan"
></A
></A
><B
>writeTChan</B
> ::  <A HREF="Control-Concurrent-STM-TChan.html#t%3ATChan"
>TChan</A
> a -&gt; a -&gt; <A HREF="../base/GHC-Conc.html#t%3ASTM"
>STM</A
> <A HREF="../ghc-prim/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="doc"
>Write a value to a <TT
><A HREF="Control-Concurrent-STM-TChan.html#t%3ATChan"
>TChan</A
></TT
>.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:dupTChan"
><A NAME="v%3AdupTChan"
></A
></A
><B
>dupTChan</B
> ::  <A HREF="Control-Concurrent-STM-TChan.html#t%3ATChan"
>TChan</A
> a -&gt; <A HREF="../base/GHC-Conc.html#t%3ASTM"
>STM</A
> (<A HREF="Control-Concurrent-STM-TChan.html#t%3ATChan"
>TChan</A
> a)</TD
></TR
><TR
><TD CLASS="doc"
>Duplicate a <TT
><A HREF="Control-Concurrent-STM-TChan.html#t%3ATChan"
>TChan</A
></TT
>: 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.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:unGetTChan"
><A NAME="v%3AunGetTChan"
></A
></A
><B
>unGetTChan</B
> ::  <A HREF="Control-Concurrent-STM-TChan.html#t%3ATChan"
>TChan</A
> a -&gt; a -&gt; <A HREF="../base/GHC-Conc.html#t%3ASTM"
>STM</A
> <A HREF="../ghc-prim/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="doc"
>Put a data item back onto a channel, where it will be the next item read.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:isEmptyTChan"
><A NAME="v%3AisEmptyTChan"
></A
></A
><B
>isEmptyTChan</B
> ::  <A HREF="Control-Concurrent-STM-TChan.html#t%3ATChan"
>TChan</A
> a -&gt; <A HREF="../base/GHC-Conc.html#t%3ASTM"
>STM</A
> <A HREF="../ghc-prim/GHC-Bool.html#t%3ABool"
>Bool</A
></TD
></TR
><TR
><TD CLASS="doc"
>Returns <TT
><A HREF="../ghc-prim/GHC-Bool.html#v%3ATrue"
>True</A
></TT
> if the supplied <TT
><A HREF="Control-Concurrent-STM-TChan.html#t%3ATChan"
>TChan</A
></TT
> is empty.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 2.4.2</TD
></TR
></TABLE
></BODY
></HTML
>