Safe Haskell	None
Language	Haskell2010

Control.Monad.Class.MonadAsync

Synopsis

class ( MonadSTM m, MonadThread m) => MonadAsync m where
- type Async m = (async :: Type -> Type ) | async -> m
- async :: m a -> m ( Async m a)
- asyncThreadId :: Async m a -> ThreadId m
- withAsync :: m a -> ( Async m a -> m b) -> m b
- waitSTM :: Async m a -> STM m a
- pollSTM :: Async m a -> STM m ( Maybe ( Either SomeException a))
- waitCatchSTM :: Async m a -> STM m ( Either SomeException a)
- waitAnySTM :: [ Async m a] -> STM m ( Async m a, a)
- waitAnyCatchSTM :: [ Async m a] -> STM m ( Async m a, Either SomeException a)
- waitEitherSTM :: Async m a -> Async m b -> STM m ( Either a b)
- waitEitherSTM_ :: Async m a -> Async m b -> STM m ()
- waitEitherCatchSTM :: Async m a -> Async m b -> STM m ( Either ( Either SomeException a) ( Either SomeException b))
- waitBothSTM :: Async m a -> Async m b -> STM m (a, b)
- wait :: Async m a -> m a
- poll :: Async m a -> m ( Maybe ( Either SomeException a))
- waitCatch :: Async m a -> m ( Either SomeException a)
- cancel :: Async m a -> m ()
- cancelWith :: Exception e => Async m a -> e -> m ()
- uninterruptibleCancel :: Async m a -> m ()
- waitAny :: [ Async m a] -> m ( Async m a, a)
- waitAnyCatch :: [ Async m a] -> m ( Async m a, Either SomeException a)
- waitAnyCancel :: [ Async m a] -> m ( Async m a, a)
- waitAnyCatchCancel :: [ Async m a] -> m ( Async m a, Either SomeException a)
- waitEither :: Async m a -> Async m b -> m ( Either a b)
- waitEitherCatch :: Async m a -> Async m b -> m ( Either ( Either SomeException a) ( Either SomeException b))
- waitEitherCancel :: Async m a -> Async m b -> m ( Either a b)
- waitEitherCatchCancel :: Async m a -> Async m b -> m ( Either ( Either SomeException a) ( Either SomeException b))
- waitEither_ :: Async m a -> Async m b -> m ()
- waitBoth :: Async m a -> Async m b -> m (a, b)
- race :: m a -> m b -> m ( Either a b)
- race_ :: m a -> m b -> m ()
- concurrently :: m a -> m b -> m (a, b)
- concurrently_ :: m a -> m b -> m ()
- asyncWithUnmask :: (( forall b. m b -> m b) -> m a) -> m ( Async m a)
data AsyncCancelled = AsyncCancelled
data ExceptionInLinkedThread = ExceptionInLinkedThread String SomeException
link :: ( MonadAsync m, MonadFork m, MonadMask m) => Async m a -> m ()
linkTo :: ( MonadAsync m, MonadFork m, MonadMask m) => ThreadId m -> Async m a -> m ()
linkOnly :: forall m a. ( MonadAsync m, MonadFork m, MonadMask m) => ( SomeException -> Bool ) -> Async m a -> m ()
linkToOnly :: forall m a. ( MonadAsync m, MonadFork m, MonadMask m) => ThreadId m -> ( SomeException -> Bool ) -> Async m a -> m ()
mapConcurrently :: ( Traversable t, MonadAsync m) => (a -> m b) -> t a -> m (t b)
forConcurrently :: ( Traversable t, MonadAsync m) => t a -> (a -> m b) -> m (t b)
mapConcurrently_ :: ( Foldable f, MonadAsync m) => (a -> m b) -> f a -> m ()
forConcurrently_ :: ( Foldable f, MonadAsync m) => f a -> (a -> m b) -> m ()
replicateConcurrently :: MonadAsync m => Int -> m a -> m [a]
replicateConcurrently_ :: MonadAsync m => Int -> m a -> m ()
newtype Concurrently m a = Concurrently {
- runConcurrently :: m a
}

Documentation

class ( MonadSTM m, MonadThread m) => MonadAsync m where Source #

Minimal complete definition

async , asyncThreadId , cancel , cancelWith , asyncWithUnmask , waitCatchSTM , pollSTM

Associated Types

type Async m = (async :: Type -> Type ) | async -> m Source #

An asynchronous action

Methods

async :: m a -> m ( Async m a) Source #

asyncThreadId :: Async m a -> ThreadId m Source #

withAsync :: m a -> ( Async m a -> m b) -> m b Source #

default withAsync :: MonadMask m => m a -> ( Async m a -> m b) -> m b Source #

waitSTM :: Async m a -> STM m a Source #

default waitSTM :: MonadThrow ( STM m) => Async m a -> STM m a Source #

pollSTM :: Async m a -> STM m ( Maybe ( Either SomeException a)) Source #

waitCatchSTM :: Async m a -> STM m ( Either SomeException a) Source #

waitAnySTM :: [ Async m a] -> STM m ( Async m a, a) Source #

default waitAnySTM :: MonadThrow ( STM m) => [ Async m a] -> STM m ( Async m a, a) Source #

waitAnyCatchSTM :: [ Async m a] -> STM m ( Async m a, Either SomeException a) Source #

waitEitherSTM :: Async m a -> Async m b -> STM m ( Either a b) Source #

default waitEitherSTM :: MonadThrow ( STM m) => Async m a -> Async m b -> STM m ( Either a b) Source #

waitEitherSTM_ :: Async m a -> Async m b -> STM m () Source #

default waitEitherSTM_ :: MonadThrow ( STM m) => Async m a -> Async m b -> STM m () Source #

waitEitherCatchSTM :: Async m a -> Async m b -> STM m ( Either ( Either SomeException a) ( Either SomeException b)) Source #

waitBothSTM :: Async m a -> Async m b -> STM m (a, b) Source #

default waitBothSTM :: MonadThrow ( STM m) => Async m a -> Async m b -> STM m (a, b) Source #

wait :: Async m a -> m a Source #

poll :: Async m a -> m ( Maybe ( Either SomeException a)) Source #

waitCatch :: Async m a -> m ( Either SomeException a) Source #

cancel :: Async m a -> m () Source #

cancelWith :: Exception e => Async m a -> e -> m () Source #

uninterruptibleCancel :: Async m a -> m () Source #

default uninterruptibleCancel :: MonadMask m => Async m a -> m () Source #

waitAny :: [ Async m a] -> m ( Async m a, a) Source #

waitAnyCatch :: [ Async m a] -> m ( Async m a, Either SomeException a) Source #

waitAnyCancel :: [ Async m a] -> m ( Async m a, a) Source #

default waitAnyCancel :: MonadThrow m => [ Async m a] -> m ( Async m a, a) Source #

waitAnyCatchCancel :: [ Async m a] -> m ( Async m a, Either SomeException a) Source #

default waitAnyCatchCancel :: MonadThrow m => [ Async m a] -> m ( Async m a, Either SomeException a) Source #

waitEither :: Async m a -> Async m b -> m ( Either a b) Source #

waitEitherCatch :: Async m a -> Async m b -> m ( Either ( Either SomeException a) ( Either SomeException b)) Source #

Note, IO-based implementations should override the default implementation. See the async package implementation and comments. http://hackage.haskell.org/package/async-2.2.1/docs/src/Control.Concurrent.Async.html#waitEitherCatch

waitEitherCancel :: Async m a -> Async m b -> m ( Either a b) Source #

default waitEitherCancel :: MonadThrow m => Async m a -> Async m b -> m ( Either a b) Source #

waitEitherCatchCancel :: Async m a -> Async m b -> m ( Either ( Either SomeException a) ( Either SomeException b)) Source #

default waitEitherCatchCancel :: MonadThrow m => Async m a -> Async m b -> m ( Either ( Either SomeException a) ( Either SomeException b)) Source #

waitEither_ :: Async m a -> Async m b -> m () Source #

waitBoth :: Async m a -> Async m b -> m (a, b) Source #

race :: m a -> m b -> m ( Either a b) Source #

race_ :: m a -> m b -> m () Source #

concurrently :: m a -> m b -> m (a, b) Source #

concurrently_ :: m a -> m b -> m () Source #

asyncWithUnmask :: (( forall b. m b -> m b) -> m a) -> m ( Async m a) Source #

Instances

Instances details

MonadAsync IO Source #
Instance details Defined in Control.Monad.Class.MonadAsync Associated Types type Async IO = (async :: Type -> Type ) Source # Methods async :: IO a -> IO ( Async IO a) Source # asyncThreadId :: Async IO a -> ThreadId IO Source # withAsync :: IO a -> ( Async IO a -> IO b) -> IO b Source # waitSTM :: Async IO a -> STM IO a Source # pollSTM :: Async IO a -> STM IO ( Maybe ( Either SomeException a)) Source # waitCatchSTM :: Async IO a -> STM IO ( Either SomeException a) Source # waitAnySTM :: [ Async IO a] -> STM IO ( Async IO a, a) Source # waitAnyCatchSTM :: [ Async IO a] -> STM IO ( Async IO a, Either SomeException a) Source # waitEitherSTM :: Async IO a -> Async IO b -> STM IO ( Either a b) Source # waitEitherSTM_ :: Async IO a -> Async IO b -> STM IO () Source # waitEitherCatchSTM :: Async IO a -> Async IO b -> STM IO ( Either ( Either SomeException a) ( Either SomeException b)) Source # waitBothSTM :: Async IO a -> Async IO b -> STM IO (a, b) Source # wait :: Async IO a -> IO a Source # poll :: Async IO a -> IO ( Maybe ( Either SomeException a)) Source # waitCatch :: Async IO a -> IO ( Either SomeException a) Source # cancel :: Async IO a -> IO () Source # cancelWith :: Exception e => Async IO a -> e -> IO () Source # uninterruptibleCancel :: Async IO a -> IO () Source # waitAny :: [ Async IO a] -> IO ( Async IO a, a) Source # waitAnyCatch :: [ Async IO a] -> IO ( Async IO a, Either SomeException a) Source # waitAnyCancel :: [ Async IO a] -> IO ( Async IO a, a) Source # waitAnyCatchCancel :: [ Async IO a] -> IO ( Async IO a, Either SomeException a) Source # waitEither :: Async IO a -> Async IO b -> IO ( Either a b) Source # waitEitherCatch :: Async IO a -> Async IO b -> IO ( Either ( Either SomeException a) ( Either SomeException b)) Source # waitEitherCancel :: Async IO a -> Async IO b -> IO ( Either a b) Source # waitEitherCatchCancel :: Async IO a -> Async IO b -> IO ( Either ( Either SomeException a) ( Either SomeException b)) Source # waitEither_ :: Async IO a -> Async IO b -> IO () Source # waitBoth :: Async IO a -> Async IO b -> IO (a, b) Source # race :: IO a -> IO b -> IO ( Either a b) Source # race_ :: IO a -> IO b -> IO () Source # concurrently :: IO a -> IO b -> IO (a, b) Source # concurrently_ :: IO a -> IO b -> IO () Source # asyncWithUnmask :: (( forall b. IO b -> IO b) -> IO a) -> IO ( Async IO a) Source #
( MonadAsync m, MonadCatch ( STM m)) => MonadAsync ( ReaderT r m) Source #
Instance details Defined in Control.Monad.Class.MonadAsync Associated Types type Async ( ReaderT r m) = (async :: Type -> Type ) Source # Methods async :: ReaderT r m a -> ReaderT r m ( Async ( ReaderT r m) a) Source # asyncThreadId :: Async ( ReaderT r m) a -> ThreadId ( ReaderT r m) Source # withAsync :: ReaderT r m a -> ( Async ( ReaderT r m) a -> ReaderT r m b) -> ReaderT r m b Source # waitSTM :: Async ( ReaderT r m) a -> STM ( ReaderT r m) a Source # pollSTM :: Async ( ReaderT r m) a -> STM ( ReaderT r m) ( Maybe ( Either SomeException a)) Source # waitCatchSTM :: Async ( ReaderT r m) a -> STM ( ReaderT r m) ( Either SomeException a) Source # waitAnySTM :: [ Async ( ReaderT r m) a] -> STM ( ReaderT r m) ( Async ( ReaderT r m) a, a) Source # waitAnyCatchSTM :: [ Async ( ReaderT r m) a] -> STM ( ReaderT r m) ( Async ( ReaderT r m) a, Either SomeException a) Source # waitEitherSTM :: Async ( ReaderT r m) a -> Async ( ReaderT r m) b -> STM ( ReaderT r m) ( Either a b) Source # waitEitherSTM_ :: Async ( ReaderT r m) a -> Async ( ReaderT r m) b -> STM ( ReaderT r m) () Source # waitEitherCatchSTM :: Async ( ReaderT r m) a -> Async ( ReaderT r m) b -> STM ( ReaderT r m) ( Either ( Either SomeException a) ( Either SomeException b)) Source # waitBothSTM :: Async ( ReaderT r m) a -> Async ( ReaderT r m) b -> STM ( ReaderT r m) (a, b) Source # wait :: Async ( ReaderT r m) a -> ReaderT r m a Source # poll :: Async ( ReaderT r m) a -> ReaderT r m ( Maybe ( Either SomeException a)) Source # waitCatch :: Async ( ReaderT r m) a -> ReaderT r m ( Either SomeException a) Source # cancel :: Async ( ReaderT r m) a -> ReaderT r m () Source # cancelWith :: Exception e => Async ( ReaderT r m) a -> e -> ReaderT r m () Source # uninterruptibleCancel :: Async ( ReaderT r m) a -> ReaderT r m () Source # waitAny :: [ Async ( ReaderT r m) a] -> ReaderT r m ( Async ( ReaderT r m) a, a) Source # waitAnyCatch :: [ Async ( ReaderT r m) a] -> ReaderT r m ( Async ( ReaderT r m) a, Either SomeException a) Source # waitAnyCancel :: [ Async ( ReaderT r m) a] -> ReaderT r m ( Async ( ReaderT r m) a, a) Source # waitAnyCatchCancel :: [ Async ( ReaderT r m) a] -> ReaderT r m ( Async ( ReaderT r m) a, Either SomeException a) Source # waitEither :: Async ( ReaderT r m) a -> Async ( ReaderT r m) b -> ReaderT r m ( Either a b) Source # waitEitherCatch :: Async ( ReaderT r m) a -> Async ( ReaderT r m) b -> ReaderT r m ( Either ( Either SomeException a) ( Either SomeException b)) Source # waitEitherCancel :: Async ( ReaderT r m) a -> Async ( ReaderT r m) b -> ReaderT r m ( Either a b) Source # waitEitherCatchCancel :: Async ( ReaderT r m) a -> Async ( ReaderT r m) b -> ReaderT r m ( Either ( Either SomeException a) ( Either SomeException b)) Source # waitEither_ :: Async ( ReaderT r m) a -> Async ( ReaderT r m) b -> ReaderT r m () Source # waitBoth :: Async ( ReaderT r m) a -> Async ( ReaderT r m) b -> ReaderT r m (a, b) Source # race :: ReaderT r m a -> ReaderT r m b -> ReaderT r m ( Either a b) Source # race_ :: ReaderT r m a -> ReaderT r m b -> ReaderT r m () Source # concurrently :: ReaderT r m a -> ReaderT r m b -> ReaderT r m (a, b) Source # concurrently_ :: ReaderT r m a -> ReaderT r m b -> ReaderT r m () Source # asyncWithUnmask :: (( forall b. ReaderT r m b -> ReaderT r m b) -> ReaderT r m a) -> ReaderT r m ( Async ( ReaderT r m) a) Source #

data AsyncCancelled Source #

The exception thrown by cancel to terminate a thread.

Constructors

AsyncCancelled

Instances

Instances details

Eq AsyncCancelled
Instance details Defined in Control.Concurrent.Async Methods (==) :: AsyncCancelled -> AsyncCancelled -> Bool Source # (/=) :: AsyncCancelled -> AsyncCancelled -> Bool Source #
Show AsyncCancelled
Instance details Defined in Control.Concurrent.Async Methods showsPrec :: Int -> AsyncCancelled -> ShowS Source # show :: AsyncCancelled -> String Source # showList :: [ AsyncCancelled ] -> ShowS Source #
Exception AsyncCancelled
Instance details Defined in Control.Concurrent.Async Methods toException :: AsyncCancelled -> SomeException Source # fromException :: SomeException -> Maybe AsyncCancelled Source # displayException :: AsyncCancelled -> String Source #

data ExceptionInLinkedThread Source #

Exception from child thread re-raised in parent thread

We record the thread ID of the child thread as a String . This avoids an m parameter in the type, which is important: ExceptionInLinkedThread must be an instance of Exception , requiring it to be Typeable ; if m appeared in the type, we would require m to be Typeable , which does not work with with the simulator, as it would require a Typeable constraint on the s parameter of IOSim .

Constructors

ExceptionInLinkedThread String SomeException

Instances

Instances details

Show ExceptionInLinkedThread Source #
Instance details Defined in Control.Monad.Class.MonadAsync Methods showsPrec :: Int -> ExceptionInLinkedThread -> ShowS Source # show :: ExceptionInLinkedThread -> String Source # showList :: [ ExceptionInLinkedThread ] -> ShowS Source #
Exception ExceptionInLinkedThread Source #
Instance details Defined in Control.Monad.Class.MonadAsync Methods toException :: ExceptionInLinkedThread -> SomeException Source # fromException :: SomeException -> Maybe ExceptionInLinkedThread Source # displayException :: ExceptionInLinkedThread -> String Source #

link :: ( MonadAsync m, MonadFork m, MonadMask m) => Async m a -> m () Source #

linkTo :: ( MonadAsync m, MonadFork m, MonadMask m) => ThreadId m -> Async m a -> m () Source #

Generalizion of link that links an async to an arbitrary thread.

linkOnly :: forall m a. ( MonadAsync m, MonadFork m, MonadMask m) => ( SomeException -> Bool ) -> Async m a -> m () Source #

linkToOnly :: forall m a. ( MonadAsync m, MonadFork m, MonadMask m) => ThreadId m -> ( SomeException -> Bool ) -> Async m a -> m () Source #

mapConcurrently :: ( Traversable t, MonadAsync m) => (a -> m b) -> t a -> m (t b) Source #

forConcurrently :: ( Traversable t, MonadAsync m) => t a -> (a -> m b) -> m (t b) Source #

mapConcurrently_ :: ( Foldable f, MonadAsync m) => (a -> m b) -> f a -> m () Source #

forConcurrently_ :: ( Foldable f, MonadAsync m) => f a -> (a -> m b) -> m () Source #

replicateConcurrently :: MonadAsync m => Int -> m a -> m [a] Source #

replicateConcurrently_ :: MonadAsync m => Int -> m a -> m () Source #

newtype Concurrently m a Source #

Similar to Concurrently but which works for any MonadAsync instance.

Constructors

Concurrently
Fields runConcurrently :: m a

Instances

Instances details

Functor m => Functor ( Concurrently m) Source #
Instance details Defined in Control.Monad.Class.MonadAsync Methods fmap :: (a -> b) -> Concurrently m a -> Concurrently m b Source # (<$) :: a -> Concurrently m b -> Concurrently m a Source #
MonadAsync m => Applicative ( Concurrently m) Source #
Instance details Defined in Control.Monad.Class.MonadAsync Methods pure :: a -> Concurrently m a Source # (<>) :: Concurrently m (a -> b) -> Concurrently m a -> Concurrently m b Source # liftA2 :: (a -> b -> c) -> Concurrently m a -> Concurrently m b -> Concurrently m c Source # (>) :: Concurrently m a -> Concurrently m b -> Concurrently m b Source # (<*) :: Concurrently m a -> Concurrently m b -> Concurrently m a Source #
( MonadAsync m, MonadTimer m) => Alternative ( Concurrently m) Source #
Instance details Defined in Control.Monad.Class.MonadAsync Methods empty :: Concurrently m a Source # (<\|>) :: Concurrently m a -> Concurrently m a -> Concurrently m a Source # some :: Concurrently m a -> Concurrently m [a] Source # many :: Concurrently m a -> Concurrently m [a] Source #
( Semigroup a, MonadAsync m) => Semigroup ( Concurrently m a) Source #
Instance details Defined in Control.Monad.Class.MonadAsync Methods (<>) :: Concurrently m a -> Concurrently m a -> Concurrently m a Source # sconcat :: NonEmpty ( Concurrently m a) -> Concurrently m a Source # stimes :: Integral b => b -> Concurrently m a -> Concurrently m a Source #
( Monoid a, MonadAsync m) => Monoid ( Concurrently m a) Source #
Instance details Defined in Control.Monad.Class.MonadAsync Methods mempty :: Concurrently m a Source # mappend :: Concurrently m a -> Concurrently m a -> Concurrently m a Source # mconcat :: [ Concurrently m a] -> Concurrently m a Source #