Control.Monad.Class.MonadAsync

async API compatible with both IO and IOSim.

Documentation

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

Minimal complete definition

async, asyncBound, asyncOn, asyncThreadId, cancel, cancelWith, asyncWithUnmask, asyncOnWithUnmask, waitCatchSTM, pollSTM

Associated Types

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

An asynchronous action

See Async.

Methods

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

See async.

asyncBound :: m a -> m (Async m a)

See asyncBound.

asyncOn :: Int -> m a -> m (Async m a)

See asyncOn.

asyncThreadId :: Async m a -> ThreadId m

See asyncThreadId.

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

See withAsync.

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

withAsyncBound :: m a -> (Async m a -> m b) -> m b

See withAsyncBound.

default withAsyncBound :: MonadMask m => m a -> (Async m a -> m b) -> m b

withAsyncOn :: Int -> m a -> (Async m a -> m b) -> m b

See withAsyncOn.

default withAsyncOn :: MonadMask m => Int -> m a -> (Async m a -> m b) -> m b

waitSTM :: Async m a -> STM m a

See waitSTM.

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

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

See pollSTM.

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

See waitCatchSTM.

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

See waitAnySTM.

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

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

See waitAnyCatchSTM.

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

See waitEitherSTM.

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

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

See waitEitherSTM_.

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

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

See waitEitherCatchSTM.

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

See waitBothSTM.

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

wait :: Async m a -> m a

See wait.

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

See poll.

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

See waitCatch.

cancel :: Async m a -> m ()

See cancel.

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

See cancelWith.

uninterruptibleCancel :: Async m a -> m ()

See uninterruptibleCancel.

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

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

See waitAny.

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

See waitAnyCatch.

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

See waitAnyCancel.

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

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

See waitAnyCatchCancel.

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

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

See waitEither.

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

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

See waitEitherCatch.

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

See waitEitherCancel.

default waitEitherCancel :: MonadThrow m => 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))

See waitEitherCatchCancel.

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

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

See waitEither_.

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

See waitBoth.

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

See race.

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

See race_.

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

See concurrently.

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

See concurrently_.

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

See concurrently_.

asyncOnWithUnmask :: Int -> ((forall b. m b -> m b) -> m a) -> m (Async m a)

See asyncOnWithUnmask.

withAsyncWithUnmask :: ((forall c. m c -> m c) -> m a) -> (Async m a -> m b) -> m b

See withAsyncWithUnmask.

default withAsyncWithUnmask :: MonadMask m => ((forall c. m c -> m c) -> m a) -> (Async m a -> m b) -> m b

withAsyncOnWithUnmask :: Int -> ((forall c. m c -> m c) -> m a) -> (Async m a -> m b) -> m b

See withAsyncOnWithUnmask.

default withAsyncOnWithUnmask :: MonadMask m => Int -> ((forall c. m c -> m c) -> m a) -> (Async m a -> m b) -> m b

compareAsyncs :: Async m a -> Async m b -> Ordering

See compareAsyncs.

default compareAsyncs :: Ord (ThreadId m) => Async m a -> Async m b -> Ordering

Instances

MonadAsync IO

Defined in Control.Monad.Class.MonadAsync

Associated Types

type Async IO = (async :: Type -> Type)

Methods

async :: IO a -> IO (Async IO a)

asyncBound :: IO a -> IO (Async IO a)

asyncOn :: Int -> IO a -> IO (Async IO a)

asyncThreadId :: Async IO a -> ThreadId IO

withAsync :: IO a -> (Async IO a -> IO b) -> IO b

withAsyncBound :: IO a -> (Async IO a -> IO b) -> IO b

withAsyncOn :: Int -> IO a -> (Async IO a -> IO b) -> IO b

waitSTM :: Async IO a -> STM IO a

pollSTM :: Async IO a -> STM IO (Maybe (Either SomeException a))

waitCatchSTM :: Async IO a -> STM IO (Either SomeException a)

waitAnySTM :: [Async IO a] -> STM IO (Async IO a, a)

waitAnyCatchSTM :: [Async IO a] -> STM IO (Async IO a, Either SomeException a)

waitEitherSTM :: Async IO a -> Async IO b -> STM IO (Either a b)

waitEitherSTM_ :: Async IO a -> Async IO b -> STM IO ()

waitEitherCatchSTM :: Async IO a -> Async IO b -> STM IO (Either (Either SomeException a) (Either SomeException b))

waitBothSTM :: Async IO a -> Async IO b -> STM IO (a, b)

wait :: Async IO a -> IO a

poll :: Async IO a -> IO (Maybe (Either SomeException a))

waitCatch :: Async IO a -> IO (Either SomeException a)

cancel :: Async IO a -> IO ()

cancelWith :: Exception e => Async IO a -> e -> IO ()

uninterruptibleCancel :: Async IO a -> IO ()

waitAny :: [Async IO a] -> IO (Async IO a, a)

waitAnyCatch :: [Async IO a] -> IO (Async IO a, Either SomeException a)

waitAnyCancel :: [Async IO a] -> IO (Async IO a, a)

waitAnyCatchCancel :: [Async IO a] -> IO (Async IO a, Either SomeException a)

waitEither :: Async IO a -> Async IO b -> IO (Either a b)

waitEitherCatch :: Async IO a -> Async IO b -> IO (Either (Either SomeException a) (Either SomeException b))

waitEitherCancel :: Async IO a -> Async IO b -> IO (Either a b)

waitEitherCatchCancel :: Async IO a -> Async IO b -> IO (Either (Either SomeException a) (Either SomeException b))

waitEither_ :: Async IO a -> Async IO b -> IO ()

waitBoth :: Async IO a -> Async IO b -> IO (a, b)

race :: IO a -> IO b -> IO (Either a b)

race_ :: IO a -> IO b -> IO ()

concurrently :: IO a -> IO b -> IO (a, b)

concurrently_ :: IO a -> IO b -> IO ()

asyncWithUnmask :: ((forall b. IO b -> IO b) -> IO a) -> IO (Async IO a)

asyncOnWithUnmask :: Int -> ((forall b. IO b -> IO b) -> IO a) -> IO (Async IO a)

withAsyncWithUnmask :: ((forall c. IO c -> IO c) -> IO a) -> (Async IO a -> IO b) -> IO b

withAsyncOnWithUnmask :: Int -> ((forall c. IO c -> IO c) -> IO a) -> (Async IO a -> IO b) -> IO b

compareAsyncs :: Async IO a -> Async IO b -> Ordering

(MonadAsync m, MonadCatch (STM m), MonadFork m, MonadMask m) => MonadAsync (ReaderT r m)

Defined in Control.Monad.Class.MonadAsync

Associated Types

type Async (ReaderT r m) = (async :: Type -> Type)

Methods

async :: ReaderT r m a -> ReaderT r m (Async (ReaderT r m) a)

asyncBound :: ReaderT r m a -> ReaderT r m (Async (ReaderT r m) a)

asyncOn :: Int -> ReaderT r m a -> ReaderT r m (Async (ReaderT r m) a)

asyncThreadId :: Async (ReaderT r m) a -> ThreadId (ReaderT r m)

withAsync :: ReaderT r m a -> (Async (ReaderT r m) a -> ReaderT r m b) -> ReaderT r m b

withAsyncBound :: ReaderT r m a -> (Async (ReaderT r m) a -> ReaderT r m b) -> ReaderT r m b

withAsyncOn :: Int -> ReaderT r m a -> (Async (ReaderT r m) a -> ReaderT r m b) -> ReaderT r m b

waitSTM :: Async (ReaderT r m) a -> STM (ReaderT r m) a

pollSTM :: Async (ReaderT r m) a -> STM (ReaderT r m) (Maybe (Either SomeException a))

waitCatchSTM :: Async (ReaderT r m) a -> STM (ReaderT r m) (Either SomeException a)

waitAnySTM :: [Async (ReaderT r m) a] -> STM (ReaderT r m) (Async (ReaderT r m) a, a)

waitAnyCatchSTM :: [Async (ReaderT r m) a] -> STM (ReaderT r m) (Async (ReaderT r m) a, Either SomeException a)

waitEitherSTM :: Async (ReaderT r m) a -> Async (ReaderT r m) b -> STM (ReaderT r m) (Either a b)

waitEitherSTM_ :: Async (ReaderT r m) a -> Async (ReaderT r m) b -> STM (ReaderT r m) ()

waitEitherCatchSTM :: Async (ReaderT r m) a -> Async (ReaderT r m) b -> STM (ReaderT r m) (Either (Either SomeException a) (Either SomeException b))

waitBothSTM :: Async (ReaderT r m) a -> Async (ReaderT r m) b -> STM (ReaderT r m) (a, b)

wait :: Async (ReaderT r m) a -> ReaderT r m a

poll :: Async (ReaderT r m) a -> ReaderT r m (Maybe (Either SomeException a))

waitCatch :: Async (ReaderT r m) a -> ReaderT r m (Either SomeException a)

cancel :: Async (ReaderT r m) a -> ReaderT r m ()

cancelWith :: Exception e => Async (ReaderT r m) a -> e -> ReaderT r m ()

uninterruptibleCancel :: Async (ReaderT r m) a -> ReaderT r m ()

waitAny :: [Async (ReaderT r m) a] -> ReaderT r m (Async (ReaderT r m) a, a)

waitAnyCatch :: [Async (ReaderT r m) a] -> ReaderT r m (Async (ReaderT r m) a, Either SomeException a)

waitAnyCancel :: [Async (ReaderT r m) a] -> ReaderT r m (Async (ReaderT r m) a, a)

waitAnyCatchCancel :: [Async (ReaderT r m) a] -> ReaderT r m (Async (ReaderT r m) a, Either SomeException a)

waitEither :: Async (ReaderT r m) a -> Async (ReaderT r m) b -> ReaderT r m (Either a b)

waitEitherCatch :: Async (ReaderT r m) a -> Async (ReaderT r m) b -> ReaderT r m (Either (Either SomeException a) (Either SomeException b))

waitEitherCancel :: Async (ReaderT r m) a -> Async (ReaderT r m) b -> ReaderT r m (Either a b)

waitEitherCatchCancel :: Async (ReaderT r m) a -> Async (ReaderT r m) b -> ReaderT r m (Either (Either SomeException a) (Either SomeException b))

waitEither_ :: Async (ReaderT r m) a -> Async (ReaderT r m) b -> ReaderT r m ()

waitBoth :: Async (ReaderT r m) a -> Async (ReaderT r m) b -> ReaderT r m (a, b)

race :: ReaderT r m a -> ReaderT r m b -> ReaderT r m (Either a b)

race_ :: ReaderT r m a -> ReaderT r m b -> ReaderT r m ()

concurrently :: ReaderT r m a -> ReaderT r m b -> ReaderT r m (a, b)

concurrently_ :: ReaderT r m a -> ReaderT r m b -> ReaderT r m ()

asyncWithUnmask :: ((forall b. ReaderT r m b -> ReaderT r m b) -> ReaderT r m a) -> ReaderT r m (Async (ReaderT r m) a)

asyncOnWithUnmask :: Int -> ((forall b. ReaderT r m b -> ReaderT r m b) -> ReaderT r m a) -> ReaderT r m (Async (ReaderT r m) a)

withAsyncWithUnmask :: ((forall c. ReaderT r m c -> ReaderT r m c) -> ReaderT r m a) -> (Async (ReaderT r m) a -> ReaderT r m b) -> ReaderT r m b

withAsyncOnWithUnmask :: Int -> ((forall c. ReaderT r m c -> ReaderT r m c) -> ReaderT r m a) -> (Async (ReaderT r m) a -> ReaderT r m b) -> ReaderT r m b

compareAsyncs :: Async (ReaderT r m) a -> Async (ReaderT r m) b -> Ordering

data AsyncCancelled

The exception thrown by cancel to terminate a thread.

Constructors

AsyncCancelled

Instances

Exception AsyncCancelled

Defined in Control.Concurrent.Async.Internal

Methods

toException :: AsyncCancelled -> SomeException

fromException :: SomeException -> Maybe AsyncCancelled

displayException :: AsyncCancelled -> String

Show AsyncCancelled

Defined in Control.Concurrent.Async.Internal

Methods

showsPrec :: Int -> AsyncCancelled -> ShowS

show :: AsyncCancelled -> String

showList :: [AsyncCancelled] -> ShowS

Eq AsyncCancelled

Defined in Control.Concurrent.Async.Internal

Methods

(==) :: AsyncCancelled -> AsyncCancelled -> Bool

(/=) :: AsyncCancelled -> AsyncCancelled -> Bool

data ExceptionInLinkedThread

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

Exception ExceptionInLinkedThread

Defined in Control.Monad.Class.MonadAsync

Methods

toException :: ExceptionInLinkedThread -> SomeException

fromException :: SomeException -> Maybe ExceptionInLinkedThread

displayException :: ExceptionInLinkedThread -> String

Show ExceptionInLinkedThread

Defined in Control.Monad.Class.MonadAsync

Methods

showsPrec :: Int -> ExceptionInLinkedThread -> ShowS

show :: ExceptionInLinkedThread -> String

showList :: [ExceptionInLinkedThread] -> ShowS

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

Like link.

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

Like linkOnly.

link2 :: (MonadAsync m, MonadFork m, MonadMask m) => Async m a -> Async m b -> m ()

Like link2.

link2Only :: (MonadAsync m, MonadFork m, MonadMask m) => (SomeException -> Bool) -> Async m a -> Async m b -> m ()

Like link2Only.

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

See mapConcurrently.

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

See forConcurrently.

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

See mapConcurrently_.

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

See forConcurrently_.

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

See replicateConcurrently.

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

See replicateConcurrently_.

newtype Concurrently m a

Similar to Concurrently but which works for any MonadAsync instance.

Constructors

Concurrently

Fields

• runConcurrently :: m a

Instances

(MonadAsync m, MonadTimer m) => Alternative (Concurrently m)

Defined in Control.Monad.Class.MonadAsync

Methods

empty :: Concurrently m a

(<|>) :: Concurrently m a -> Concurrently m a -> Concurrently m a

some :: Concurrently m a -> Concurrently m [a]

many :: Concurrently m a -> Concurrently m [a]

MonadAsync m => Applicative (Concurrently m)

Defined in Control.Monad.Class.MonadAsync

Methods

pure :: a -> Concurrently m a

(<*>) :: Concurrently m (a -> b) -> Concurrently m a -> Concurrently m b

liftA2 :: (a -> b -> c) -> Concurrently m a -> Concurrently m b -> Concurrently m c

(*>) :: Concurrently m a -> Concurrently m b -> Concurrently m b

(<*) :: Concurrently m a -> Concurrently m b -> Concurrently m a

Functor m => Functor (Concurrently m)

Defined in Control.Monad.Class.MonadAsync

Methods

fmap :: (a -> b) -> Concurrently m a -> Concurrently m b

(<$) :: a -> Concurrently m b -> Concurrently m a

(Monoid a, MonadAsync m) => Monoid (Concurrently m a)

Defined in Control.Monad.Class.MonadAsync

Methods

mempty :: Concurrently m a

mappend :: Concurrently m a -> Concurrently m a -> Concurrently m a

mconcat :: [Concurrently m a] -> Concurrently m a

(Semigroup a, MonadAsync m) => Semigroup (Concurrently m a)

Defined in Control.Monad.Class.MonadAsync

Methods

(<>) :: Concurrently m a -> Concurrently m a -> Concurrently m a

sconcat :: NonEmpty (Concurrently m a) -> Concurrently m a

stimes :: Integral b => b -> Concurrently m a -> Concurrently m a