Control.Concurrent.Async.Lifted · lifted-async-0.11.0

Asynchronous actions

1 declaration

datadata Async a

An asynchronous action spawned by async or withAsync. Asynchronous actions are executed in a separate thread, and operations are provided for waiting for asynchronous actions to complete and obtaining their results (see e.g. wait).

Instances4Functor, Eq, Ord, Hashable

Functor AsyncDefined in async-2.2.5 · Control.Concurrent.Async.Internal
Eq (Async a)Defined in async-2.2.5 · Control.Concurrent.Async.Internal
Ord (Async a)Defined in async-2.2.5 · Control.Concurrent.Async.Internal
Hashable (Async a)Defined in async-2.2.5 · Control.Concurrent.Async.Internal

Spawning

valueasync :: MonadBaseControl IO m => m a -> m (Async (StM m a))

#

Generalized version of async.

valueasyncBound :: MonadBaseControl IO m => m a -> m (Async (StM m a))

#

Generalized version of asyncBound.

valueasyncOn :: MonadBaseControl IO m => Int -> m a -> m (Async (StM m a))

#

Generalized version of asyncOn.

valueasyncWithUnmask

:: MonadBaseControl IO m
=> (forall b. m b -> m b) -> m a
-> m (Async (StM m a))

#

Generalized version of asyncWithUnmask.

valueasyncOnWithUnmask

:: MonadBaseControl IO m
=> Int
-> (forall b. m b -> m b) -> m a
-> m (Async (StM m a))

#

Generalized version of asyncOnWithUnmask.

Spawning with automatic cancelation

valuewithAsync :: MonadBaseControl IO m => m a -> (Async (StM m a) -> m b) -> m b

#

Generalized version of withAsync.

valuewithAsyncBound

:: MonadBaseControl IO m
=> m a
-> Async (StM m a) -> m b
-> m b

#

Generalized version of withAsyncBound.

valuewithAsyncOn

:: MonadBaseControl IO m
=> Int
-> m a
-> Async (StM m a) -> m b
-> m b

#

Generalized version of withAsyncOn.

valuewithAsyncWithUnmask

:: MonadBaseControl IO m
=> (forall c. m c -> m c) -> m a
-> Async (StM m a) -> m b
-> m b

#

Generalized version of withAsyncWithUnmask.

valuewithAsyncOnWithUnmask

:: MonadBaseControl IO m
=> Int
-> (forall c. m c -> m c) -> m a
-> Async (StM m a) -> m b
-> m b

#

Generalized version of withAsyncOnWithUnmask.

Quering Asyncs

valuewait :: MonadBaseControl IO m => Async (StM m a) -> m a

#

Generalized version of wait.

valuepoll

:: MonadBaseControl IO m
=> Async (StM m a)
-> m (Maybe (Either SomeException a))

#

Generalized version of poll.

valuewaitCatch

:: MonadBaseControl IO m
=> Async (StM m a)
-> m (Either SomeException a)

#

Generalized version of waitCatch.

valuecancel :: MonadBase IO m => Async a -> m ()

#

Generalized version of cancel.

valueuninterruptibleCancel :: MonadBase IO m => Async a -> m ()

#

Generalized version of uninterruptibleCancel.

valuecancelWith :: (MonadBase IO m, Exception e) => Async a -> e -> m ()

#

Generalized version of cancelWith.

valueasyncThreadId :: Async a -> ThreadId

#

Returns the ThreadId of the thread running the given Async.

datadata AsyncCancelled

#

The exception thrown by cancel to terminate a thread.

AsyncCancelled

Instances3Eq, Show, Exception

Eq AsyncCancelledDefined in async-2.2.5 · Control.Concurrent.Async.Internal
Show AsyncCancelledDefined in async-2.2.5 · Control.Concurrent.Async.Internal
Exception AsyncCancelledDefined in async-2.2.5 · Control.Concurrent.Async.Internal

STM operations

valuewaitSTM :: Async a -> STM a

#

A version of wait that can be used inside an STM transaction.

valuepollSTM :: Async a -> STM (Maybe (Either SomeException a))

#

A version of poll that can be used inside an STM transaction.

valuewaitCatchSTM :: Async a -> STM (Either SomeException a)

#

A version of waitCatch that can be used inside an STM transaction.

Waiting for multiple Asyncs

valuewaitAny

:: MonadBaseControl IO m
=> [Async (StM m a)]
-> m (Async (StM m a), a)

#

Generalized version of waitAny.

valuewaitAnyCatch

:: MonadBaseControl IO m
=> [Async (StM m a)]
-> m (Async (StM m a), Either SomeException a)

#

Generalized version of waitAnyCatch.

valuewaitAnyCancel

:: MonadBaseControl IO m
=> [Async (StM m a)]
-> m (Async (StM m a), a)

#

Generalized version of waitAnyCancel.

valuewaitAnyCatchCancel

:: MonadBaseControl IO m
=> [Async (StM m a)]
-> m (Async (StM m a), Either SomeException a)

#

Generalized version of waitAnyCatchCancel.

valuewaitEither

:: MonadBaseControl IO m
=> Async (StM m a)
-> Async (StM m b)
-> m (Either a b)

#

Generalized version of waitEither.

valuewaitEitherCatch

:: MonadBaseControl IO m
=> Async (StM m a)
-> Async (StM m b)
-> m (Either (Either SomeException a) (Either SomeException b))

#

Generalized version of waitEitherCatch.

valuewaitEitherCancel

:: MonadBaseControl IO m
=> Async (StM m a)
-> Async (StM m b)
-> m (Either a b)

#

Generalized version of waitEitherCancel.

valuewaitEitherCatchCancel

:: MonadBaseControl IO m
=> Async (StM m a)
-> Async (StM m b)
-> m (Either (Either SomeException a) (Either SomeException b))

#

Generalized version of waitEitherCatchCancel.

valuewaitEither_ :: MonadBase IO m => Async a -> Async b -> m ()

#

Generalized version of waitEither_.

NOTE: This function discards the monadic effects besides IO in the forked computation.

valuewaitBoth

:: MonadBaseControl IO m
=> Async (StM m a)
-> Async (StM m b)
-> m (a, b)

#

Generalized version of waitBoth.

Waiting for multiple Asyncs in STM

valuewaitAnySTM :: [Async a] -> STM (Async a, a)

#

A version of waitAny that can be used inside an STM transaction.

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

#

A version of waitAnyCatch that can be used inside an STM transaction.

valuewaitEitherSTM :: Async a -> Async b -> STM (Either a b)

#

A version of waitEither that can be used inside an STM transaction.

valuewaitEitherCatchSTM

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

#

A version of waitEitherCatch that can be used inside an STM transaction.

valuewaitEitherSTM_ :: Async a -> Async b -> STM ()

#

A version of waitEither_ that can be used inside an STM transaction.

valuewaitBothSTM :: Async a -> Async b -> STM (a, b)

#

A version of waitBoth that can be used inside an STM transaction.

Linking

valuelink :: MonadBase IO m => Async a -> m ()

#

Generalized version of link.

valuelink2 :: MonadBase IO m => Async a -> Async b -> m ()

#

Generalized version of link2.

datadata ExceptionInLinkedThread

#

Constructors

forall a. ExceptionInLinkedThread (Async a) SomeException

Instances2Show, Exception

Show ExceptionInLinkedThreadDefined in async-2.2.5 · Control.Concurrent.Async.Internal
Exception ExceptionInLinkedThreadDefined in async-2.2.5 · Control.Concurrent.Async.Internal

Convenient utilities

12 declarations

valuerace :: MonadBaseControl IO m => m a -> m b -> m (Either a b)

#

Generalized version of race.

valuerace_ :: MonadBaseControl IO m => m a -> m b -> m ()

#

Generalized version of race_.

NOTE: This function discards the monadic effects besides IO in the forked computation.

valueconcurrently :: MonadBaseControl IO m => m a -> m b -> m (a, b)

#

Generalized version of concurrently.

valueconcurrently_ :: MonadBaseControl IO m => m a -> m b -> m ()

#

Generalized version of concurrently_.

valuemapConcurrently

:: (Traversable t, MonadBaseControl IO m)
=> a -> m b
-> t a
-> m (t b)

#

Generalized version of mapConcurrently.

valuemapConcurrently_

:: (Foldable t, MonadBaseControl IO m)
=> a -> m b
-> t a
-> m ()

#

Generalized version of mapConcurrently_.

valueforConcurrently

:: (Traversable t, MonadBaseControl IO m)
=> t a
-> a -> m b
-> m (t b)

#

Generalized version of forConcurrently.

valueforConcurrently_

:: (Foldable t, MonadBaseControl IO m)
=> t a
-> a -> m b
-> m ()

#

Generalized version of forConcurrently_.

valuereplicateConcurrently :: MonadBaseControl IO m => Int -> m a -> m [a]

#

Generalized version of replicateConcurrently.

valuereplicateConcurrently_ :: MonadBaseControl IO m => Int -> m a -> m ()

#

Generalized version of replicateConcurrently_.

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

#

Generalized version of Concurrently.

A value of type Concurrently m a is an IO-based operation that can be composed with other Concurrently values, using the Applicative and Alternative instances.

Calling runConcurrently on a value of type Concurrently m a will execute the IO-based lifted operations it contains concurrently, before delivering the result of type a.

For example

  (page1, page2, page3) <- runConcurrently $ (,,)
    <$> Concurrently (getURL "url1")
    <*> Concurrently (getURL "url2")
    <*> Concurrently (getURL "url3")

Constructors

Concurrently
- runConcurrently :: m a

Instances5Functor, Applicative, Alternative, Semigroup, Monoid

Functor m => Functor (Concurrently m)Defined in lifted-async-0.11.0 · Control.Concurrent.Async.Lifted
MonadBaseControl IO m => Applicative (Concurrently m)Defined in lifted-async-0.11.0 · Control.Concurrent.Async.Lifted
MonadBaseControl IO m => Alternative (Concurrently m)Defined in lifted-async-0.11.0 · Control.Concurrent.Async.Lifted
(MonadBaseControl IO m, Semigroup a) => Semigroup (Concurrently m a)Defined in lifted-async-0.11.0 · Control.Concurrent.Async.Lifted
(MonadBaseControl IO m, Semigroup a, Monoid a) => Monoid (Concurrently m a)Defined in lifted-async-0.11.0 · Control.Concurrent.Async.Lifted

valuecompareAsyncs :: Async a -> Async b -> Ordering

#

Compare two Asyncs that may have different types by their ThreadId.