Simulation.Aivika.Experiment.MRef

Tested with: GHC 7.8.3

The module defines a shared mutable reference accessible from different threads.

Documentation

data MRef a

This is a shared mutable reference accessible from different threads.

newMRef :: a -> IO (MRef a)

Create a new shared reference with the specified initial value.

readMRef :: MRef a -> IO a

Read the contents of the shared reference.

maybeReadMRef :: b -> (a -> IO b) -> MRef (Maybe a) -> IO b

Like maybe but for the shared reference under assumption that the reference is updated only once by its initial value.

writeMRef :: MRef a -> a -> IO ()

Update the contents of the shared reference.

maybeWriteMRef :: MRef (Maybe a) -> IO a -> (a -> IO b) -> IO b

Update the contents if the reference was empty and then return a result of applying the specified function to either the initial or current value.

modifyMRef_ :: MRef a -> (a -> IO a) -> IO ()

Modify the contents of the shared reference.

modifyMRef :: MRef a -> (a -> IO (a, b)) -> IO b

Modify the contents of the shared reference but allow returning the result.

withMRef :: MRef a -> (a -> IO b) -> IO b

A safe wrapper for operating with the contents of shared reference.