Modulelifted-async-0.11.0Haskell2010

Control.Concurrent.Async.Lifted.Safe

This is a safe variant of Control.Concurrent.Async.Lifted.

This module assumes your monad stack to satisfy StM m a ~ a so you can't mess up monadic effects. If your monad stack is stateful, use Control.Concurrent.Async.Lifted with special care.

Contents

Asynchronous actions
Spawning
Spawning with automatic cancelation
Quering Asyncs
STM operations
Waiting for multiple Asyncs
Waiting for multiple Asyncs in STM
Linking
Convenient utilities

Synopsis

data Async
class Pure
class Forall
value async
value asyncBound
value asyncOn
value asyncWithUnmask
value asyncOnWithUnmask
value withAsync
value withAsyncBound
value withAsyncOn
value withAsyncWithUnmask
value withAsyncOnWithUnmask
value wait
value poll
value waitCatch
value cancel
value uninterruptibleCancel
value cancelWith
value asyncThreadId
data AsyncCancelled
value waitSTM
value pollSTM
value waitCatchSTM
value waitAny
value waitAnyCatch
value waitAnyCancel
value waitAnyCatchCancel
value waitEither
value waitEitherCatch
value waitEitherCancel
value waitEitherCatchCancel
value waitEither_
value waitBoth
value waitAnySTM
value waitAnyCatchSTM
value waitEitherSTM
value waitEitherCatchSTM
value waitEitherSTM_
value waitBothSTM
value link
value link2
data ExceptionInLinkedThread
value race
value race_
value concurrently
value concurrently_
value mapConcurrently
value mapConcurrently_
value forConcurrently
value forConcurrently_
value replicateConcurrently
value replicateConcurrently_
data Concurrently
value compareAsyncs

Packagelifted-async-0.11.0
Exports55
LanguageHaskell2010
LicenceBSD-3-Clause
SourceSafe.hs

Asynchronous actions

datadata Async a

Source#

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.6 · Control.Concurrent.Async.Internal
Eq (Async a)Defined in async-2.2.6 · Control.Concurrent.Async.Internal
Ord (Async a)Defined in async-2.2.6 · Control.Concurrent.Async.Internal
Hashable (Async a)Defined in async-2.2.6 · Control.Concurrent.Async.Internal

classclass StM m a ~ a => Pure (m :: Type -> Type) a

Source#

Most of the functions in this module have Forall (Pure m) in their constraints, which means they require the monad m satisfies StM m a ~ a for all a.

Instances1Pure

StM m a ~ a => Pure m aDefined in lifted-async-0.11.0 · Control.Concurrent.Async.Lifted.Safe

classclass (forall (a :: k). p a) => Forall (p :: k -> Constraint)

Instances1Forall

(forall (a :: k). p a) => Forall pDefined in constraints-0.14.4 · Data.Constraint.Forall

Spawning

valueasync :: (MonadBaseControl IO m, Forall (Pure m)) => m a -> m (Async a)

Source#

Generalized version of async.

valueasyncBound :: (MonadBaseControl IO m, Forall (Pure m)) => m a -> m (Async a)

Source#

Generalized version of asyncBound.

valueasyncOn

:: (MonadBaseControl IO m, Forall (Pure m))
=> Int
-> m a
-> m (Async a)

Source#

Generalized version of asyncOn.

valueasyncWithUnmask

:: (MonadBaseControl IO m, Forall (Pure m))
=> (forall b. m b -> m b) -> m a
-> m (Async a)

Source#

Generalized version of asyncWithUnmask.

valueasyncOnWithUnmask

:: (MonadBaseControl IO m, Forall (Pure m))
=> Int
-> (forall b. m b -> m b) -> m a
-> m (Async a)

Source#

Generalized version of asyncOnWithUnmask.

Spawning with automatic cancelation

valuewithAsync

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

Source#

Generalized version of withAsync.

valuewithAsyncBound

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

Source#

Generalized version of withAsyncBound.

valuewithAsyncOn

:: (MonadBaseControl IO m, Forall (Pure m))
=> Int
-> m a
-> Async a -> m b
-> m b

Source#

Generalized version of withAsyncOn.

valuewithAsyncWithUnmask

:: (MonadBaseControl IO m, Forall (Pure m))
=> (forall c. m c -> m c) -> m a
-> Async a -> m b
-> m b

Source#

Generalized version of withAsyncWithUnmask.

valuewithAsyncOnWithUnmask

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

Source#

Generalized version of withAsyncOnWithUnmask.

Quering Asyncs

valuewait :: (MonadBase IO m, Forall (Pure m)) => Async a -> m a

Source#

Generalized version of wait.

valuepoll

:: (MonadBase IO m, Forall (Pure m))
=> Async a
-> m (Maybe (Either SomeException a))

Source#

Generalized version of poll.

valuewaitCatch

:: (MonadBase IO m, Forall (Pure m))
=> Async a
-> m (Either SomeException a)

Source#

Generalized version of waitCatch.

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

Source#

Generalized version of cancel.

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

Source#

Generalized version of uninterruptibleCancel.

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

Source#

Generalized version of cancelWith.

valueasyncThreadId :: Async a -> ThreadId

Source#

Returns the ThreadId of the thread running the given Async.

datadata AsyncCancelled

Source#

The exception thrown by cancel to terminate a thread.

AsyncCancelled

Instances3Eq, Show, Exception

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

STM operations

valuewaitSTM :: Async a -> STM a

Source#

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

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

Source#

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

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

Source#

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

Waiting for multiple Asyncs

valuewaitAny :: (MonadBase IO m, Forall (Pure m)) => [Async a] -> m (Async a, a)

Source#

Generalized version of waitAny.

valuewaitAnyCatch

:: (MonadBase IO m, Forall (Pure m))
=> [Async a]
-> m (Async a, Either SomeException a)

Source#

Generalized version of waitAnyCatch.

valuewaitAnyCancel

:: (MonadBase IO m, Forall (Pure m))
=> [Async a]
-> m (Async a, a)

Source#

Generalized version of waitAnyCancel.

valuewaitAnyCatchCancel

:: (MonadBase IO m, Forall (Pure m))
=> [Async a]
-> m (Async a, Either SomeException a)

Source#

Generalized version of waitAnyCatchCancel.

valuewaitEither

:: (MonadBase IO m, Forall (Pure m))
=> Async a
-> Async b
-> m (Either a b)

Source#

Generalized version of waitEither.

valuewaitEitherCatch

:: (MonadBase IO m, Forall (Pure m))
=> Async a
-> Async b
-> m (Either (Either SomeException a) (Either SomeException b))

Source#

Generalized version of waitEitherCatch.

valuewaitEitherCancel

:: (MonadBase IO m, Forall (Pure m))
=> Async a
-> Async b
-> m (Either a b)

Source#

Generalized version of waitEitherCancel.

valuewaitEitherCatchCancel

:: (MonadBase IO m, Forall (Pure m))
=> Async a
-> Async b
-> m (Either (Either SomeException a) (Either SomeException b))

Source#

Generalized version of waitEitherCatchCancel.

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

Source#

Generalized version of waitEither_

valuewaitBoth

:: (MonadBase IO m, Forall (Pure m))
=> Async a
-> Async b
-> m (a, b)

Source#

Generalized version of waitBoth.

Waiting for multiple Asyncs in STM

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

Source#

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

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

Source#

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

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

Source#

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))

Source#

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

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

Source#

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

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

Source#

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

Linking

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

Source#

Generalized version of link.

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

Source#

Generalized version of link2.

datadata ExceptionInLinkedThread

Constructors

forall a. ExceptionInLinkedThread (Async a) SomeException

Instances2Show, Exception

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

Convenient utilities

valuerace

:: (MonadBaseControl IO m, Forall (Pure m))
=> m a
-> m b
-> m (Either a b)

Source#

Generalized version of race.

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

Source#

Generalized version of race_.

valueconcurrently

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

Source#

Generalized version of concurrently.

valueconcurrently_

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

Source#

Generalized version of concurrently_.

valuemapConcurrently

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

Source#

Generalized version of mapConcurrently.

valuemapConcurrently_

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

Source#

Generalized version of mapConcurrently_.

valueforConcurrently

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

Source#

Generalized version of forConcurrently.

valueforConcurrently_

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

Source#

Generalized version of forConcurrently_.

valuereplicateConcurrently

:: (MonadBaseControl IO m, Forall (Pure m))
=> Int
-> m a
-> m [a]

Source#

Generalized version of replicateConcurrently.

valuereplicateConcurrently_

:: (MonadBaseControl IO m, Forall (Pure m))
=> Int
-> m a
-> m ()

Source#

Generalized version of replicateConcurrently_.

datadata Concurrently (m :: Type -> Type) a where

Source#

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 :: Forall (Pure m) => m a -> Concurrently m a
- runConcurrently :: m a

Instances5Functor, Applicative, Alternative, Semigroup, Monoid

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

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

Source#

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