Control.Concurrent.BoundedChan

Implements bounded channels. These channels differ from normal Chans in that they are guaranteed to contain no more than a certain number of elements. This is ideal when you may be writing to a channel faster than you are able to read from it.

This module supports all the functions of Control.Concurrent.Chan except unGetChan and dupChan, which are not supported for bounded channels.

Documentation

data BoundedChan a

BoundedChan is an abstract data type representing a bounded channel.

newBoundedChan :: Int -> IO (BoundedChan a)

newBoundedChan n returns a channel than can contain no more than n elements.

writeChan :: BoundedChan a -> a -> IO ()

Write an element to the channel. If the channel is full, this routine will block until it is able to write. If you have multiple writers, be careful here, because the unlocking is not guaranteed to avoid starvation.

readChan :: BoundedChan a -> IO a

Read an element from the channel. If the channel is empty, this routine will block until it is able to read.

isEmptyChan :: BoundedChan a -> IO Bool

Returns True if the supplied channel is empty.

getChanContents :: BoundedChan a -> IO [a]

Return a lazy list representing the contents of the supplied channel.

writeList2Chan :: BoundedChan a -> [a] -> IO ()

Write a list of elements to the channel. If the channel becomes full, this routine will block until it is able to write.