io-classes-1.8.0.1: Type classes for concurrency with STM, ST and timing

Safe Haskell	None
Language	GHC2021

Control.Concurrent.Class.MonadMVar

Contents

non-standard extensions

Synopsis

class Monad m => MonadMVar (m :: Type -> Type) where
- type MVar (m :: Type -> Type) :: Type -> Type
- newEmptyMVar :: m (MVar m a)
- takeMVar :: MVar m a -> m a
- putMVar :: MVar m a -> a -> m ()
- tryTakeMVar :: MVar m a -> m (Maybe a)
- tryPutMVar :: MVar m a -> a -> m Bool
- isEmptyMVar :: MVar m a -> m Bool
- newMVar :: a -> m (MVar m a)
- readMVar :: MVar m a -> m a
- tryReadMVar :: MVar m a -> m (Maybe a)
- swapMVar :: MVar m a -> a -> m a
- withMVar :: MVar m a -> (a -> m b) -> m b
- withMVarMasked :: MVar m a -> (a -> m b) -> m b
- modifyMVar_ :: MVar m a -> (a -> m a) -> m ()
- modifyMVar :: MVar m a -> (a -> m (a, b)) -> m b
- modifyMVarMasked_ :: MVar m a -> (a -> m a) -> m ()
- modifyMVarMasked :: MVar m a -> (a -> m (a, b)) -> m b
class (MonadMVar m, Monad (InspectMVarMonad m)) => MonadInspectMVar (m :: Type -> Type) where
- type InspectMVarMonad (m :: Type -> Type) :: Type -> Type
- inspectMVar :: proxy m -> MVar m a -> InspectMVarMonad m (Maybe a)
class MonadTraceMVar (m :: Type -> Type) where
- traceMVarIO :: proxy -> MVar m a -> (Maybe (Maybe a) -> Maybe a -> InspectMVarMonad m TraceValue) -> m ()
class MonadMVar m => MonadLabelledMVar (m :: Type -> Type) where
- labelMVar :: MVar m a -> String -> m ()

Documentation

class Monad m => MonadMVar (m :: Type -> Type) where Source #

Minimal complete definition

newEmptyMVar, takeMVar, tryTakeMVar, putMVar, tryPutMVar, readMVar, tryReadMVar, isEmptyMVar

Associated Types

type MVar (m :: Type -> Type) :: Type -> Type Source #

Methods

newEmptyMVar :: m (MVar m a) Source #

See newEmptyMVar.

takeMVar :: MVar m a -> m a Source #

See takeMVar.

putMVar :: MVar m a -> a -> m () Source #

See putMVar.

tryTakeMVar :: MVar m a -> m (Maybe a) Source #

See tryTakeMVar.

tryPutMVar :: MVar m a -> a -> m Bool Source #

See tryPutMVar.

isEmptyMVar :: MVar m a -> m Bool Source #

See isEmptyMVar.

newMVar :: a -> m (MVar m a) Source #

See newMVar.

default newMVar :: a -> m (MVar m a) Source #

readMVar :: MVar m a -> m a Source #

See readMVar.

tryReadMVar :: MVar m a -> m (Maybe a) Source #

See tryReadMVar.

swapMVar :: MVar m a -> a -> m a Source #

See swapMVar.

default swapMVar :: MonadMask m => MVar m a -> a -> m a Source #

withMVar :: MVar m a -> (a -> m b) -> m b Source #

See withMVar.

default withMVar :: MonadMask m => MVar m a -> (a -> m b) -> m b Source #

withMVarMasked :: MVar m a -> (a -> m b) -> m b Source #

See withMVarMasked.

default withMVarMasked :: MonadMask m => MVar m a -> (a -> m b) -> m b Source #

modifyMVar_ :: MVar m a -> (a -> m a) -> m () Source #

See modifyMVar_.

default modifyMVar_ :: MonadMask m => MVar m a -> (a -> m a) -> m () Source #

modifyMVar :: MVar m a -> (a -> m (a, b)) -> m b Source #

See modifyMVar.

default modifyMVar :: (MonadMask m, MonadEvaluate m) => MVar m a -> (a -> m (a, b)) -> m b Source #

modifyMVarMasked_ :: MVar m a -> (a -> m a) -> m () Source #

See modifyMVarMasked_.

default modifyMVarMasked_ :: MonadMask m => MVar m a -> (a -> m a) -> m () Source #

modifyMVarMasked :: MVar m a -> (a -> m (a, b)) -> m b Source #

See modifyMVarMasked.

default modifyMVarMasked :: (MonadMask m, MonadEvaluate m) => MVar m a -> (a -> m (a, b)) -> m b Source #

Instances

Instances details

MonadMVar IO Source #

Instance details

Defined in Control.Concurrent.Class.MonadMVar

Associated Types

type MVar IO
Instance details Defined in Control.Concurrent.Class.MonadMVar type MVar IO = MVar

Methods

newEmptyMVar :: IO (MVar IO a) Source #

takeMVar :: MVar IO a -> IO a Source #

putMVar :: MVar IO a -> a -> IO () Source #

tryTakeMVar :: MVar IO a -> IO (Maybe a) Source #

tryPutMVar :: MVar IO a -> a -> IO Bool Source #

isEmptyMVar :: MVar IO a -> IO Bool Source #

newMVar :: a -> IO (MVar IO a) Source #

readMVar :: MVar IO a -> IO a Source #

tryReadMVar :: MVar IO a -> IO (Maybe a) Source #

swapMVar :: MVar IO a -> a -> IO a Source #

withMVar :: MVar IO a -> (a -> IO b) -> IO b Source #

withMVarMasked :: MVar IO a -> (a -> IO b) -> IO b Source #

modifyMVar_ :: MVar IO a -> (a -> IO a) -> IO () Source #

modifyMVar :: MVar IO a -> (a -> IO (a, b)) -> IO b Source #

modifyMVarMasked_ :: MVar IO a -> (a -> IO a) -> IO () Source #

modifyMVarMasked :: MVar IO a -> (a -> IO (a, b)) -> IO b Source #

(MonadMask m, MonadMVar m) => MonadMVar (ReaderT r m) Source #

Instance details

Defined in Control.Concurrent.Class.MonadMVar

Associated Types

type MVar (ReaderT r m)
Instance details Defined in Control.Concurrent.Class.MonadMVar type MVar (ReaderT r m)

Methods

newEmptyMVar :: ReaderT r m (MVar (ReaderT r m) a) Source #

takeMVar :: MVar (ReaderT r m) a -> ReaderT r m a Source #

putMVar :: MVar (ReaderT r m) a -> a -> ReaderT r m () Source #

tryTakeMVar :: MVar (ReaderT r m) a -> ReaderT r m (Maybe a) Source #

tryPutMVar :: MVar (ReaderT r m) a -> a -> ReaderT r m Bool Source #

isEmptyMVar :: MVar (ReaderT r m) a -> ReaderT r m Bool Source #

newMVar :: a -> ReaderT r m (MVar (ReaderT r m) a) Source #

readMVar :: MVar (ReaderT r m) a -> ReaderT r m a Source #

tryReadMVar :: MVar (ReaderT r m) a -> ReaderT r m (Maybe a) Source #

swapMVar :: MVar (ReaderT r m) a -> a -> ReaderT r m a Source #

withMVar :: MVar (ReaderT r m) a -> (a -> ReaderT r m b) -> ReaderT r m b Source #

withMVarMasked :: MVar (ReaderT r m) a -> (a -> ReaderT r m b) -> ReaderT r m b Source #

modifyMVar_ :: MVar (ReaderT r m) a -> (a -> ReaderT r m a) -> ReaderT r m () Source #

modifyMVar :: MVar (ReaderT r m) a -> (a -> ReaderT r m (a, b)) -> ReaderT r m b Source #

modifyMVarMasked_ :: MVar (ReaderT r m) a -> (a -> ReaderT r m a) -> ReaderT r m () Source #

modifyMVarMasked :: MVar (ReaderT r m) a -> (a -> ReaderT r m (a, b)) -> ReaderT r m b Source #

non-standard extensions

class (MonadMVar m, Monad (InspectMVarMonad m)) => MonadInspectMVar (m :: Type -> Type) where Source #

This type class is intended for 'io-sim', where one might want to access an MVar in the underlying ST monad.

Associated Types

type InspectMVarMonad (m :: Type -> Type) :: Type -> Type Source #

Methods

inspectMVar :: proxy m -> MVar m a -> InspectMVarMonad m (Maybe a) Source #

Return the value of an MVar as an InspectMVarMonad computation. Can be Nothing if the MVar is empty.

Instances

Instances details

MonadInspectMVar IO Source #

Instance details

Defined in Control.Concurrent.Class.MonadMVar

Associated Types

type InspectMVarMonad IO
Instance details Defined in Control.Concurrent.Class.MonadMVar type InspectMVarMonad IO = IO

Methods

inspectMVar :: proxy IO -> MVar IO a -> InspectMVarMonad IO (Maybe a) Source #

class MonadTraceMVar (m :: Type -> Type) where Source #

Methods

traceMVarIO :: proxy -> MVar m a -> (Maybe (Maybe a) -> Maybe a -> InspectMVarMonad m TraceValue) -> m () Source #

Instances

Instances details

MonadTraceMVar IO Source #
Instance details Defined in Control.Concurrent.Class.MonadMVar Methods traceMVarIO :: proxy -> MVar IO a -> (Maybe (Maybe a) -> Maybe a -> InspectMVarMonad IO TraceValue) -> IO () Source #

class MonadMVar m => MonadLabelledMVar (m :: Type -> Type) where Source #

Labelled MVars

The IO instances is no-op, the IOSim instance enhances simulation trace. This is very useful when analysing low lever concurrency issues (e.g. deadlocks, livelocks etc).

Methods

labelMVar :: MVar m a -> String -> m () Source #

Name an MVar

Instances

Instances details

MonadLabelledMVar IO Source #
Instance details Defined in Control.Concurrent.Class.MonadMVar Methods labelMVar :: MVar IO a -> String -> IO () Source #