| Copyright | Copyright (C) 2012-2015 Mitsutoshi Aoe |
|---|---|
| License | BSD-style (see the file LICENSE) |
| Maintainer | Mitsutoshi Aoe <maoe@foldr.in> |
| Stability | experimental |
| Safe Haskell | None |
| Language | Haskell98 |
Control.Concurrent.Async.Lifted.Safe
Contents
Description
This is a safe variant of Control.Concurrent.Async.Lifted.
This module assumes your monad stack to satisfy so you can't
mess up monadic effects. If your monad stack is stateful, use
StM m a ~ aControl.Concurrent.Async.Lifted with special care.
- data Async a :: * -> *
- class (StM m a ~ a) => Pure m a
- type Forall p = (p A, p B)
- async :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => m a -> m (Async a)
- asyncBound :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => m a -> m (Async a)
- asyncOn :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => Int -> m a -> m (Async a)
- asyncWithUnmask :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => ((forall b. m b -> m b) -> m a) -> m (Async a)
- asyncOnWithUnmask :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => Int -> ((forall b. m b -> m b) -> m a) -> m (Async a)
- withAsync :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => m a -> (Async a -> m b) -> m b
- withAsyncBound :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => m a -> (Async a -> m b) -> m b
- withAsyncOn :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => Int -> m a -> (Async a -> m b) -> m b
- withAsyncWithUnmask :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => ((forall c. m c -> m c) -> m a) -> (Async a -> m b) -> m b
- withAsyncOnWithUnmask :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => Int -> ((forall c. m c -> m c) -> m a) -> (Async a -> m b) -> m b
- wait :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => Async a -> m a
- poll :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => Async a -> m (Maybe (Either SomeException a))
- waitCatch :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => Async a -> m (Either SomeException a)
- cancel :: MonadBase IO m => Async a -> m ()
- cancelWith :: (MonadBase IO m, Exception e) => Async a -> e -> m ()
- asyncThreadId :: Async a -> ThreadId
- waitSTM :: Async a -> STM a
- pollSTM :: Async a -> STM (Maybe (Either SomeException a))
- waitCatchSTM :: Async a -> STM (Either SomeException a)
- waitAny :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => [Async a] -> m (Async a, a)
- waitAnyCatch :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => [Async a] -> m (Async a, Either SomeException a)
- waitAnyCancel :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => [Async a] -> m (Async a, a)
- waitAnyCatchCancel :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => [Async a] -> m (Async a, Either SomeException a)
- waitEither :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => Async a -> Async b -> m (Either a b)
- waitEitherCatch :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => Async a -> Async b -> m (Either (Either SomeException a) (Either SomeException b))
- waitEitherCancel :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => Async a -> Async b -> m (Either a b)
- waitEitherCatchCancel :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => Async a -> Async b -> m (Either (Either SomeException a) (Either SomeException b))
- waitEither_ :: MonadBaseControl IO m => Async a -> Async b -> m ()
- waitBoth :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => Async a -> Async b -> m (a, b)
- link :: MonadBase IO m => Async a -> m ()
- link2 :: MonadBase IO m => Async a -> Async b -> m ()
- race :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => m a -> m b -> m (Either a b)
- race_ :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => m a -> m b -> m ()
- concurrently :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => m a -> m b -> m (a, b)
- mapConcurrently :: (Traversable t, MonadBaseControl IO m, Forall (Pure m)) => (a -> m b) -> t a -> m (t b)
- data Concurrently m a where
- Concurrently :: Forall (Pure m) => {
- runConcurrently :: m a
- Concurrently :: Forall (Pure m) => {
Asynchronous actions
data Async a :: * -> *
type Forall p = (p A, p B)
A quantified constraint
Spawning
async :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => m a -> m (Async a)
Generalized version of async.
asyncBound :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => m a -> m (Async a)
Generalized version of asyncBound.
asyncOn :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => Int -> m a -> m (Async a)
Generalized version of asyncOn.
asyncWithUnmask :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => ((forall b. m b -> m b) -> m a) -> m (Async a)
Generalized version of asyncWithUnmask.
asyncOnWithUnmask :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => Int -> ((forall b. m b -> m b) -> m a) -> m (Async a)
Generalized version of asyncOnWithUnmask.
Spawning with automatic cancelation
withAsync :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => m a -> (Async a -> m b) -> m b
Generalized version of withAsync.
withAsyncBound :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => m a -> (Async a -> m b) -> m b
Generalized version of withAsyncBound.
withAsyncOn :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => Int -> m a -> (Async a -> m b) -> m b
Generalized version of withAsyncOn.
withAsyncWithUnmask :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => ((forall c. m c -> m c) -> m a) -> (Async a -> m b) -> m b
Generalized version of withAsyncWithUnmask.
withAsyncOnWithUnmask :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => Int -> ((forall c. m c -> m c) -> m a) -> (Async a -> m b) -> m b
Generalized version of withAsyncOnWithUnmask.
Quering Asyncs
wait :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => Async a -> m a
Generalized version of wait.
poll :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => Async a -> m (Maybe (Either SomeException a))
Generalized version of poll.
waitCatch :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => Async a -> m (Either SomeException a)
Generalized version of waitCatch.
cancelWith :: (MonadBase IO m, Exception e) => Async a -> e -> m ()
Generalized version of cancelWith.
asyncThreadId :: Async a -> ThreadId
STM operations
pollSTM :: Async a -> STM (Maybe (Either SomeException a))
A version of poll that can be used inside an STM transaction.
waitCatchSTM :: Async a -> STM (Either SomeException a)
A version of waitCatch that can be used inside an STM transaction.
Waiting for multiple Asyncs
waitAny :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => [Async a] -> m (Async a, a)
Generalized version of waitAny.
waitAnyCatch :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => [Async a] -> m (Async a, Either SomeException a)
Generalized version of waitAnyCatch.
waitAnyCancel :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => [Async a] -> m (Async a, a)
Generalized version of waitAnyCancel.
waitAnyCatchCancel :: forall m a. (MonadBaseControl IO m, Forall (Pure m)) => [Async a] -> m (Async a, Either SomeException a)
Generalized version of waitAnyCatchCancel.
waitEither :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => Async a -> Async b -> m (Either a b)
Generalized version of waitEither.
waitEitherCatch :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => Async a -> Async b -> m (Either (Either SomeException a) (Either SomeException b))
Generalized version of waitEitherCatch.
waitEitherCancel :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => Async a -> Async b -> m (Either a b)
Generalized version of waitEitherCancel.
waitEitherCatchCancel :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => Async a -> Async b -> m (Either (Either SomeException a) (Either SomeException b))
Generalized version of waitEitherCatchCancel.
waitEither_ :: MonadBaseControl IO m => Async a -> Async b -> m ()
Generalized version of waitEither_.
NOTE: This function discards the monadic effects besides IO in the forked computation.
waitBoth :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => Async a -> Async b -> m (a, b)
Generalized version of waitBoth.
Linking
Convenient utilities
race :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => m a -> m b -> m (Either a b)
Generalized version of race.
race_ :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => m a -> m b -> m ()
Generalized version of race_.
concurrently :: forall m a b. (MonadBaseControl IO m, Forall (Pure m)) => m a -> m b -> m (a, b)
Generalized version of concurrently.
mapConcurrently :: (Traversable t, MonadBaseControl IO m, Forall (Pure m)) => (a -> m b) -> t a -> m (t b)
Generalized version of mapConcurrently.
data Concurrently m a where
Generalized version of Concurrently.
A value of type is an IO-based operation that can be
composed with other Concurrently m aConcurrently values, using the Applicative and
Alternative instances.
Calling runConcurrently on a value of type will
execute the IO-based lifted operations it contains concurrently, before
delivering the result of type Concurrently m aa.
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 | |
Fields
| |
Instances
| Functor m => Functor (Concurrently m) | |
| (MonadBaseControl IO m, Forall (Pure m)) => Applicative (Concurrently m) | |
| (MonadBaseControl IO m, Forall (Pure m)) => Alternative (Concurrently m) | |
| (MonadBaseControl IO m, Monoid a, Forall (Pure m)) => Monoid (Concurrently m a) |