stm-2.4.2: Software Transactional Memory

Portability | non-portable (requires STM)
Stability | experimental
Maintainer | libraries@haskell.org
Safe Haskell | Trustworthy

Control.Concurrent.STM.TMVar

Contents

- TMVars

Description

TMVar: Transactional MVars, for use in the STM monad (GHC only)

Synopsis

- data TMVar a
- newTMVar :: a -> STM (TMVar a)
- newEmptyTMVar :: STM (TMVar a)
- newTMVarIO :: a -> IO (TMVar a)
- newEmptyTMVarIO :: IO (TMVar a)
- takeTMVar :: TMVar a -> STM a
- putTMVar :: TMVar a -> a -> STM ()
- readTMVar :: TMVar a -> STM a
- tryReadTMVar :: TMVar a -> STM (Maybe a)
- swapTMVar :: TMVar a -> a -> STM a
- tryTakeTMVar :: TMVar a -> STM (Maybe a)
- tryPutTMVar :: TMVar a -> a -> STM Bool
- isEmptyTMVar :: TMVar a -> STM Bool

# TMVars

data TMVar a Source

A `TMVar` is a synchronising variable, used for communication between concurrent threads. It can be thought of as a box, which may be empty or full.

Instances

Typeable1 TMVar |
Eq (TMVar a) |

newTMVar :: a -> STM (TMVar a)Source

Create a `TMVar` which contains the supplied value.

newEmptyTMVar :: STM (TMVar a)Source

Create a `TMVar` which is initially empty.

newTMVarIO :: a -> IO (TMVar a)Source

`IO` version of `newTMVar`. This is useful for creating top-level `TMVar`s using `unsafePerformIO`, because using `atomically` inside `unsafePerformIO` isn't possible.

newEmptyTMVarIO :: IO (TMVar a)Source

`IO` version of `newEmptyTMVar`. This is useful for creating top-level `TMVar`s using `unsafePerformIO`, because using `atomically` inside `unsafePerformIO` isn't possible.

takeTMVar :: TMVar a -> STM aSource

Return the contents of the `TMVar`. If the `TMVar` is currently empty, the transaction will `retry`. After a `takeTMVar`, the `TMVar` is left empty.

putTMVar :: TMVar a -> a -> STM ()Source

Put a value into a `TMVar`. If the `TMVar` is currently full, `putTMVar` will `retry`.

readTMVar :: TMVar a -> STM aSource

This is a combination of `takeTMVar` and `putTMVar`; ie. it takes the value from the `TMVar`, puts it back, and also returns it.

tryReadTMVar :: TMVar a -> STM (Maybe a)Source

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

swapTMVar :: TMVar a -> a -> STM aSource

Swap the contents of a `TMVar` for a new value.

tryTakeTMVar :: TMVar a -> STM (Maybe a)Source

A version of `takeTMVar` that does not `retry`. The `tryTakeTMVar` function returns `Nothing` if the `TMVar` was empty, or ``Just` a` if the `TMVar` was full with contents `a`. After `tryTakeTMVar`, the `TMVar` is left empty.

tryPutTMVar :: TMVar a -> a -> STM Bool Source

A version of `putTMVar` that does not `retry`. The `tryPutTMVar` function attempts to put the value `a` into the `TMVar`, returning `True` if it was successful, or `False` otherwise.

isEmptyTMVar :: TMVar a -> STM Bool Source

Check whether a given `TMVar` is empty.