Control.Concurrent.AdvSTM.TChan

Corresponds to Control.Concurrent.STM.TChan

Documentation

data TChan a

TChan is an abstract type representing an unbounded FIFO channel.

newTChan :: MonadAdvSTM m => m (TChan a)

Build and returns a new instance of TChan

newTChanIO :: IO (TChan a)

IO version of newTChan. This is useful for creating top-level TChans using System.IO.Unsafe.unsafePerformIO, because using atomically inside System.IO.Unsafe.unsafePerformIO isn't possible.

readTChan :: MonadAdvSTM m => TChan a -> m a

Read the next value from the TChan.

writeTChan :: MonadAdvSTM m => TChan a -> a -> m ()

Write a value to a TChan.

dupTChan :: MonadAdvSTM m => TChan a -> m (TChan a)

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

unGetTChan :: MonadAdvSTM m => TChan a -> a -> m ()

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

isEmptyTChan :: MonadAdvSTM m => TChan a -> m Bool

Returns True if the supplied TChan is empty.