Control.Concurrent.STM.TChan.Class

Documentation

class SplitTChan i o | i -> o, o -> i where

A class capturing Chan operations in STM.

Methods

writeTChan :: i a -> a -> STM ()

Write a value to the in chan.

readTChan :: o a -> STM a

Read the next value from the out chan.

peekTChan :: o a -> STM a

Get the next value from the TChan without removing it, retrying if the channel is empty.

tryPeekTChan :: o a -> STM (Maybe a)

A version of peekTChan which does not retry. Instead it returns Nothing if no value is available.

tryReadTChan :: o a -> STM (Maybe a)

A version of readTChan which does not retry. Instead it returns Nothing if no value is available.

isEmptyTChan :: o a -> STM Bool

Returns True if the supplied TChan is empty.

Instances

SplitTChan TMVar TMVar

SplitTChan TChan TChan

SplitTChan InTChan OutTChan

class SplitTChan i o => NewSplitTChan i o where

A class for SplitTChan types that can be instantiated without programmer input. e.g. the standard haskell TChan is a member of this class, however a bounded chan type that took an Int to define the buffer size would not.

Methods

newSplitTChan :: STM (i a, o a)

Instances

NewSplitTChan TMVar TMVar

NewSplitTChan TChan TChan

NewSplitTChan InTChan OutTChan