Moduleouroboros-consensus-4.2.1.0

Ouroboros.Consensus.Util.MonadSTM.NormalForm

Synopsis

value throwSTM
value castStrictTMVar
value debugTraceTMVar
value debugTraceTMVarIO
value fromLazyTMVar
value isEmptyTMVar
value labelTMVar
value labelTMVarIO
value newEmptyTMVar
value newEmptyTMVarIO
value putTMVar
value readTMVar
value swapTMVar
value takeTMVar
value tryPutTMVar
value tryReadTMVar
value tryTakeTMVar
value writeTMVar
value newEmptySVar
value newSVar
value uncheckedNewEmptySVar
value uncheckedNewSVar
value castStrictSVar
value isEmptySVar
value modifySVar
value modifySVar_
value putSVar
value readSVar
value readSVarSTM
value swapSVar
value takeSVar
value tryPutSVar
value tryReadSVar
value tryTakeSVar
value updateSVar
value updateSVar_
family InspectMonadSTM
class MonadInspectSTM
class MonadLabelledSTM
class MonadSTM
class MonadTraceSTM
family STM
family TBQueue
family TQueue
data TraceValue
pattern DontTrace
pattern TraceDynamic
pattern TraceString
type LazyTMVar
newtype StrictTMVar
value toLazyTMVar
data StrictSVar

Packageouroboros-consensus-4.2.1.0
Exports52
LicenceApache-2.0

valuethrowSTM :: (MonadSTM m, MonadThrow (STM m), Exception e) => e -> STM m a

valuecastStrictTMVar

:: LazyTMVar m ~ LazyTMVar n
=> StrictTMVar m a
-> StrictTMVar n a

valuedebugTraceTMVar

:: (MonadTraceSTM m, Show a)
=> proxy m
-> StrictTMVar m a
-> STM m ()

valuedebugTraceTMVarIO :: (MonadTraceSTM m, Show a) => StrictTMVar m a -> m ()

valuefromLazyTMVar :: LazyTMVar m a -> StrictTMVar m a

valueisEmptyTMVar :: MonadSTM m => StrictTMVar m a -> STM m Bool

valuelabelTMVar :: MonadLabelledSTM m => StrictTMVar m a -> String -> STM m ()

valuelabelTMVarIO :: MonadLabelledSTM m => StrictTMVar m a -> String -> m ()

valuenewEmptyTMVar :: MonadSTM m => STM m (StrictTMVar m a)

valuenewEmptyTMVarIO :: MonadSTM m => m (StrictTMVar m a)

valueputTMVar :: MonadSTM m => StrictTMVar m a -> a -> STM m ()

valuereadTMVar :: MonadSTM m => StrictTMVar m a -> STM m a

valueswapTMVar :: MonadSTM m => StrictTMVar m a -> a -> STM m a

valuetakeTMVar :: MonadSTM m => StrictTMVar m a -> STM m a

valuetryPutTMVar :: MonadSTM m => StrictTMVar m a -> a -> STM m Bool

valuetryReadTMVar :: MonadSTM m => StrictTMVar m a -> STM m (Maybe a)

valuetryTakeTMVar :: MonadSTM m => StrictTMVar m a -> STM m (Maybe a)

valuewriteTMVar :: MonadSTM m => StrictTMVar m a -> a -> STM m ()

valuenewEmptySVar :: (MonadSTM m, NoThunks a) => a -> m (StrictSVar m a)

valuenewSVar :: (MonadSTM m, HasCallStack, NoThunks a) => a -> m (StrictSVar m a)

valueuncheckedNewEmptySVar :: MonadSTM m => a -> m (StrictSVar m a)

valueuncheckedNewSVar :: MonadSTM m => a -> m (StrictSVar m a)

valuecastStrictSVar

:: (TMVar m ~ TMVar n, TVar m ~ TVar n)
=> StrictSVar m a
-> StrictSVar n a

valueisEmptySVar :: MonadSTM m => StrictSVar m a -> m Bool

valuemodifySVar

:: (MonadSTM m, MonadCatch m, HasCallStack)
=> StrictSVar m a
-> a -> m (a, b)
-> m b

valuemodifySVar_

:: (MonadSTM m, MonadCatch m, HasCallStack)
=> StrictSVar m a
-> a -> m a
-> m ()

valueputSVar :: (MonadSTM m, HasCallStack) => StrictSVar m a -> a -> m ()

valuereadSVar :: MonadSTM m => StrictSVar m a -> m a

valuereadSVarSTM :: MonadSTM m => StrictSVar m a -> STM m a

valueswapSVar :: (MonadSTM m, HasCallStack) => StrictSVar m a -> a -> m a

valuetakeSVar :: MonadSTM m => StrictSVar m a -> m a

valuetryPutSVar :: (MonadSTM m, HasCallStack) => StrictSVar m a -> a -> m Bool

valuetryReadSVar :: MonadSTM m => StrictSVar m a -> m (Maybe a)

valuetryTakeSVar :: MonadSTM m => StrictSVar m a -> m (Maybe a)

valueupdateSVar

:: (MonadSTM m, HasCallStack)
=> StrictSVar m a
-> a -> (a, b)
-> m b

valueupdateSVar_

:: (MonadSTM m, HasCallStack)
=> StrictSVar m a
-> a -> a
-> m ()

familytype family InspectMonadSTM (m :: Type -> Type) :: Type -> Type

Instances3InspectMonadSTM

type InspectMonadSTM IO = IODefined in io-classes-1.8.0.1 · Control.Monad.Class.MonadSTM.Internal
type InspectMonadSTM (WithEarlyExit m) = InspectMonadSTM mDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Util.EarlyExit
type InspectMonadSTM (ReaderT r m) = InspectMonadSTM mDefined in io-classes-1.8.0.1 · Control.Monad.Class.MonadSTM.Internal

classclass (MonadSTM m, Monad (InspectMonadSTM m)) => MonadInspectSTM (m :: Type -> Type) where

Associated types

type family InspectMonadSTM (m :: Type -> Type) :: Type -> Type

Methods

inspectTVar :: proxy m -> TVar m a -> InspectMonadSTM m a
inspectTMVar :: proxy m -> TMVar m a -> InspectMonadSTM m (Maybe a)

Instances3MonadInspectSTM

MonadInspectSTM IODefined in io-classes-1.8.0.1 · Control.Monad.Class.MonadSTM.Internal
(MonadInspectSTM m, Monad (InspectMonadSTM m)) => MonadInspectSTM (WithEarlyExit m)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Util.EarlyExit
MonadInspectSTM m => MonadInspectSTM (ReaderT r m)Defined in io-classes-1.8.0.1 · Control.Monad.Class.MonadSTM.Internal

classclass MonadSTM m => MonadLabelledSTM (m :: Type -> Type) where

Methods

labelTQueue :: TQueue m a -> String -> STM m ()
labelTBQueue :: TBQueue m a -> String -> STM m ()
labelTQueueIO :: TQueue m a -> String -> m ()
labelTBQueueIO :: TBQueue m a -> String -> m ()

Instances2MonadLabelledSTM

MonadLabelledSTM IODefined in io-classes-1.8.0.1 · Control.Monad.Class.MonadSTM.Internal
MonadLabelledSTM m => MonadLabelledSTM (WithEarlyExit m)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Util.EarlyExit

classclass (Monad m, Monad (STM m)) => MonadSTM (m :: Type -> Type) where

Associated types

type family STM (m :: Type -> Type) :: Type -> Type
type family TQueue (m :: Type -> Type) :: Type -> Type
type family TBQueue (m :: Type -> Type) :: Type -> Type

Methods

atomically :: HasCallStack => STM m a -> m a
retry :: STM m a
orElse :: STM m a -> STM m a -> STM m a
check :: Bool -> STM m ()
newTQueue :: STM m (TQueue m a)
readTQueue :: TQueue m a -> STM m a
tryReadTQueue :: TQueue m a -> STM m (Maybe a)
peekTQueue :: TQueue m a -> STM m a
tryPeekTQueue :: TQueue m a -> STM m (Maybe a)
flushTQueue :: TQueue m a -> STM m [a]
writeTQueue :: TQueue m a -> a -> STM m ()
isEmptyTQueue :: TQueue m a -> STM m Bool
unGetTQueue :: TQueue m a -> a -> STM m ()
newTBQueue :: Natural -> STM m (TBQueue m a)
readTBQueue :: TBQueue m a -> STM m a
tryReadTBQueue :: TBQueue m a -> STM m (Maybe a)
peekTBQueue :: TBQueue m a -> STM m a
tryPeekTBQueue :: TBQueue m a -> STM m (Maybe a)
flushTBQueue :: TBQueue m a -> STM m [a]
writeTBQueue :: TBQueue m a -> a -> STM m ()
lengthTBQueue :: TBQueue m a -> STM m Natural
isEmptyTBQueue :: TBQueue m a -> STM m Bool
isFullTBQueue :: TBQueue m a -> STM m Bool
unGetTBQueue :: TBQueue m a -> a -> STM m ()
newTQueueIO :: m (TQueue m a)
newTBQueueIO :: Natural -> m (TBQueue m a)

Instances3MonadSTM

MonadSTM IODefined in io-classes-1.8.0.1 · Control.Monad.Class.MonadSTM.Internal
MonadSTM m => MonadSTM (WithEarlyExit m)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Util.EarlyExit
MonadSTM m => MonadSTM (ReaderT r m)Defined in io-classes-1.8.0.1 · Control.Monad.Class.MonadSTM.Internal

classclass MonadInspectSTM m => MonadTraceSTM (m :: Type -> Type) where

Methods

traceTMVar :: proxy m -> TMVar m a -> (Maybe (Maybe a) -> Maybe a -> InspectMonadSTM m TraceValue) -> STM m ()
traceTQueue :: proxy m -> TQueue m a -> (Maybe [a] -> [a] -> InspectMonadSTM m TraceValue) -> STM m ()
traceTBQueue :: proxy m -> TBQueue m a -> (Maybe [a] -> [a] -> InspectMonadSTM m TraceValue) -> STM m ()
traceTSem :: proxy m -> TSem m -> (Maybe Integer -> Integer -> InspectMonadSTM m TraceValue) -> STM m ()
traceTMVarIO :: TMVar m a -> (Maybe (Maybe a) -> Maybe a -> InspectMonadSTM m TraceValue) -> m ()
traceTQueueIO :: TQueue m a -> (Maybe [a] -> [a] -> InspectMonadSTM m TraceValue) -> m ()
traceTBQueueIO :: TBQueue m a -> (Maybe [a] -> [a] -> InspectMonadSTM m TraceValue) -> m ()
traceTSemIO :: TSem m -> (Maybe Integer -> Integer -> InspectMonadSTM m TraceValue) -> m ()

Instances3MonadTraceSTM

MonadTraceSTM IODefined in io-classes-1.8.0.1 · Control.Monad.Class.MonadSTM.Internal
MonadTraceSTM m => MonadTraceSTM (WithEarlyExit m)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Util.EarlyExit
MonadTraceSTM m => MonadTraceSTM (ReaderT r m)Defined in io-classes-1.8.0.1 · Control.Monad.Class.MonadSTM.Internal

familytype family STM (m :: Type -> Type) :: Type -> Type

Instances3STM

type STM IO = STMDefined in io-classes-1.8.0.1 · Control.Monad.Class.MonadSTM.Internal
type STM (WithEarlyExit m) = WithEarlyExit (STM m)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Util.EarlyExit
type STM (ReaderT r m) = ReaderT r (STM m)Defined in io-classes-1.8.0.1 · Control.Monad.Class.MonadSTM.Internal

familytype family TBQueue (m :: Type -> Type) :: Type -> Type

Instances3TBQueue

type TBQueue IO = TBQueueDefined in io-classes-1.8.0.1 · Control.Monad.Class.MonadSTM.Internal
type TBQueue (WithEarlyExit m) = TBQueue mDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Util.EarlyExit
type TBQueue (ReaderT r m) = TBQueue mDefined in io-classes-1.8.0.1 · Control.Monad.Class.MonadSTM.Internal

familytype family TQueue (m :: Type -> Type) :: Type -> Type

Instances3TQueue

type TQueue IO = TQueueDefined in io-classes-1.8.0.1 · Control.Monad.Class.MonadSTM.Internal
type TQueue (WithEarlyExit m) = TQueue mDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Util.EarlyExit
type TQueue (ReaderT r m) = TQueue mDefined in io-classes-1.8.0.1 · Control.Monad.Class.MonadSTM.Internal

datadata TraceValue where

Constructors

TraceValue :: Typeable tr => Maybe tr -> Maybe String -> TraceValue
- traceDynamic :: Maybe tr
- traceString :: Maybe String

patternpattern DontTrace :: TraceValue

patternpattern TraceDynamic :: () => Typeable tr => tr -> TraceValue

patternpattern TraceString :: String -> TraceValue

typetype LazyTMVar (m :: Type -> Type) = TMVar m

newtypenewtype StrictTMVar (m :: Type -> Type) a

Instances2NoThunks

NoThunks (StrictTMVar m a) => NoThunks (StrictTMVar (WithEarlyExit m) a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Util.EarlyExit
NoThunks a => NoThunks (StrictTMVar IO a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Util.IOLike · orphan

valuetoLazyTMVar :: StrictTMVar m a -> LazyTMVar m a

datadata StrictSVar (m :: Type -> Type) a

Constructors

StrictSVar
- invariant :: !a -> Maybe String
- tmvar :: !TMVar m a
- tvar :: !TVar m a

Instances2NoThunks

NoThunks (StrictSVar m a) => NoThunks (StrictSVar (WithEarlyExit m) a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Util.EarlyExit
NoThunks a => NoThunks (StrictSVar IO a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Util.MonadSTM.StrictSVar