base-4.5.1.0: Basic libraries

Portabilitynon-portable (concurrency)
Stabilityexperimental
Maintainer[email protected]
Safe HaskellTrustworthy

Control.Concurrent.Chan

Contents

Description

Unbounded channels.

Synopsis

The Chan type

data Chan a Source

Chan is an abstract type representing an unbounded FIFO channel.

Instances

Operations

newChan :: IO (Chan a)Source

Build and returns a new instance of Chan.

writeChan :: Chan a -> a -> IO ()Source

Write a value to a Chan.

readChan :: Chan a -> IO aSource

Read the next value from the Chan.

dupChan :: Chan a -> IO (Chan a)Source

Duplicate a Chan: 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.

(Note that a duplicated channel is not equal to its original. So: fmap (c /=) $ dupChan c returns True for all c.)

unGetChan :: Chan a -> a -> IO ()Source

Deprecated: if you need this operation, use Control.Concurrent.STM.TChan instead. See http://hackage.haskell.org/trac/ghc/ticket/4154 for details

Put a data item back onto a channel, where it will be the next item read.

isEmptyChan :: Chan a -> IO BoolSource

Deprecated: if you need this operation, use Control.Concurrent.STM.TChan instead. See http://hackage.haskell.org/trac/ghc/ticket/4154 for details

Returns True if the supplied Chan is empty.

Stream interface

getChanContents :: Chan a -> IO [a]Source

Return a lazy list representing the contents of the supplied Chan, much like hGetContents.

writeList2Chan :: Chan a -> [a] -> IO ()Source

Write an entire list of items to a Chan.