Safe Haskell	None
Language	Haskell2010

Control.Effect.Conc

Contents

Effects
Interpretations
Key actions
Concurrently applicative
Other actions
Re-exports from Control.Concurrent.Async
Carriers

Description

Interface adapted from Control.Concurrent.Async

Synopsis

data Conc m a
data Async a
concToIO :: (Carrier m, MonadBaseControlPure IO m) => ConcToIOC m a -> m a
concToUnliftIO :: Eff (Unlift IO) m => ConcToUnliftIOC m a -> m a
async :: Eff Conc m => m a -> m (Async a)
withAsync :: Eff Conc m => m a -> (Async a -> m b) -> m b
wait :: Eff Conc m => Async a -> m a
poll :: Eff Conc m => Async a -> m (Maybe (Either SomeException a))
concurrently :: Eff Conc m => m a -> m b -> m (a, b)
race :: Eff Conc m => m a -> m b -> m (Either a b)
waitEither :: Eff Conc m => Async a -> Async b -> m (Either a b)
waitBoth :: Eff Conc m => Async a -> Async b -> m (a, b)
link :: Eff Conc m => Async a -> m ()
link2 :: Eff Conc m => Async a -> Async b -> m ()
waitAny :: Eff Conc m => [Async a] -> m (Async a, a)
mapConcurrently :: (Traversable t, Eff Conc m) => (a -> m b) -> t a -> m (t b)
forConcurrently :: (Traversable t, Eff Conc m) => t a -> (a -> m b) -> m (t b)
newtype Concurrently m a = Concurrently {
- runConcurrently :: m a
}
asyncBound :: Eff Conc m => m a -> m (Async a)
asyncOn :: Eff Conc m => Int -> m a -> m (Async a)
asyncWithUnmask :: Eff Conc m => ((forall x. m x -> m x) -> m a) -> m (Async a)
asyncOnWithUnmask :: Eff Conc m => Int -> ((forall x. m x -> m x) -> m a) -> m (Async a)
withAsyncBound :: Eff Conc m => m a -> (Async a -> m b) -> m b
withAsyncWithUnmask :: Eff Conc m => ((forall x. m x -> m x) -> m a) -> (Async a -> m b) -> m b
withAsyncOnWithUnmask :: Eff Conc m => Int -> ((forall x. m x -> m x) -> m a) -> (Async a -> m b) -> m b
waitCatch :: Eff Conc m => Async a -> m (Either SomeException a)
cancel :: Eff Conc m => Async a -> m ()
uninterruptibleCancel :: Eff Conc m => Async a -> m ()
cancelWith :: Eff Conc m => (Exception e, Eff Conc m) => Async a -> e -> m ()
waitAnyCatch :: Eff Conc m => [Async a] -> m (Async a, Either SomeException a)
waitAnyCancel :: Eff Conc m => [Async a] -> m (Async a, a)
waitAnyCatchCancel :: Eff Conc m => [Async a] -> m (Async a, Either SomeException a)
waitEitherCatch :: Eff Conc m => Async a -> Async b -> m (Either (Either SomeException a) (Either SomeException b))
waitEitherCancel :: Eff Conc m => Async a -> Async b -> m (Either a b)
waitEitherCatchCancel :: Eff Conc m => Async a -> Async b -> m (Either (Either SomeException a) (Either SomeException b))
waitEither_ :: Eff Conc m => Async a -> Async b -> m ()
linkOnly :: Eff Conc m => (SomeException -> Bool) -> Async a -> m ()
link2Only :: Eff Conc m => (SomeException -> Bool) -> Async a -> Async b -> m ()
race_ :: Eff Conc m => m a -> m b -> m ()
concurrently_ :: Eff Conc m => m a -> m b -> m ()
mapConcurrently_ :: (Foldable t, Eff Conc m) => (a -> m b) -> t a -> m ()
forConcurrently_ :: (Foldable t, Eff Conc m) => t a -> (a -> m b) -> m ()
replicateConcurrently :: Eff Conc m => Int -> m a -> m [a]
replicateConcurrently_ :: Eff Conc m => Int -> m a -> m ()
asyncThreadId :: Async a -> ThreadId
data AsyncCancelled = AsyncCancelled
data ExceptionInLinkedThread = ExceptionInLinkedThread (Async a) SomeException
waitAnySTM :: [Async a] -> STM (Async a, a)
waitAnyCatchSTM :: [Async a] -> STM (Async a, Either SomeException a)
waitEitherSTM :: Async a -> Async b -> STM (Either a b)
waitEitherCatchSTM :: Async a -> Async b -> STM (Either (Either SomeException a) (Either SomeException b))
waitEitherSTM_ :: Async a -> Async b -> STM ()
waitBothSTM :: Async a -> Async b -> STM (a, b)
compareAsyncs :: Async a -> Async b -> Ordering
data ConcToIOC m a
type ConcToUnliftIOC = UnwrapC Conc

Effects

data Conc m a Source #

An effect for concurrent execution.

Instances

Instances details

EffNewtype Conc Source #
Instance details Defined in Control.Effect.Internal.Conc Associated Types type UnwrappedEff Conc :: Effect Source # Methods unwrapped :: forall (z :: Type -> Type) x. Conc z x -> UnwrappedEff Conc z x Source #
type UnwrappedEff Conc Source #
Instance details Defined in Control.Effect.Internal.Conc type UnwrappedEff Conc = UnwrappedEff (WrapperOf Conc (Unlift IO))

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

Instances

Instances details

Functor Async
Instance details Defined in Control.Concurrent.Async Methods fmap :: (a -> b) -> Async a -> Async b # (<$) :: a -> Async b -> Async a #
Eq (Async a)
Instance details Defined in Control.Concurrent.Async Methods (==) :: Async a -> Async a -> Bool # (/=) :: Async a -> Async a -> Bool #
Ord (Async a)
Instance details Defined in Control.Concurrent.Async Methods compare :: Async a -> Async a -> Ordering # (<) :: Async a -> Async a -> Bool # (<=) :: Async a -> Async a -> Bool # (>) :: Async a -> Async a -> Bool # (>=) :: Async a -> Async a -> Bool # max :: Async a -> Async a -> Async a # min :: Async a -> Async a -> Async a #
Hashable (Async a)
Instance details Defined in Control.Concurrent.Async Methods hashWithSalt :: Int -> Async a -> Int # hash :: Async a -> Int #

Interpretations

concToIO :: (Carrier m, MonadBaseControlPure IO m) => ConcToIOC m a -> m a Source #

Run a Conc effect if all effects used in the program -- past and future -- are eventually reduced to operations on IO.

Due to its very restrictive primitive effect and carrier constraint, concToIO can't be used together with most pure interpreters. For example, instead of runError, you must use errorToIO.

This poses a problem if you want to use some effect that doesn't have an interpreter compatible with concToIO -- like NonDet. In that case, you might still be able to use both effects in the same program by applying Split Interpretation to seperate their uses.

Derivs (ConcToIOC m) = Conc ': Derivs m

Prims  (ConcToIOC m) = Unlift IO ': Prims m

concToUnliftIO :: Eff (Unlift IO) m => ConcToUnliftIOC m a -> m a Source #

Transform a Conc effect into Unlift IO.

Key actions

async :: Eff Conc m => m a -> m (Async a) Source #

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

wait :: Eff Conc m => Async a -> m a Source #

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

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

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

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

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

link :: Eff Conc m => Async a -> m () Source #

link2 :: Eff Conc m => Async a -> Async b -> m () Source #

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

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

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

Concurrently applicative

newtype Concurrently m a Source #

Constructors

Concurrently
Fields runConcurrently :: m a

Instances

Instances details

Functor m => Functor (Concurrently m) Source #
Instance details Defined in Control.Effect.Conc Methods fmap :: (a -> b) -> Concurrently m a -> Concurrently m b # (<$) :: a -> Concurrently m b -> Concurrently m a #
Eff Conc m => Applicative (Concurrently m) Source #
Instance details Defined in Control.Effect.Conc 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 #
Eff Conc m => Alternative (Concurrently m) Source #
Instance details Defined in Control.Effect.Conc 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] #
(Eff Conc m, Semigroup a) => Semigroup (Concurrently m a) Source #
Instance details Defined in Control.Effect.Conc 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 #
(Eff Conc m, Monoid a) => Monoid (Concurrently m a) Source #
Instance details Defined in Control.Effect.Conc Methods mempty :: Concurrently m a # mappend :: Concurrently m a -> Concurrently m a -> Concurrently m a # mconcat :: [Concurrently m a] -> Concurrently m a #

Other actions

asyncBound :: Eff Conc m => m a -> m (Async a) Source #

asyncOn :: Eff Conc m => Int -> m a -> m (Async a) Source #

asyncWithUnmask :: Eff Conc m => ((forall x. m x -> m x) -> m a) -> m (Async a) Source #

asyncOnWithUnmask :: Eff Conc m => Int -> ((forall x. m x -> m x) -> m a) -> m (Async a) Source #

withAsyncBound :: Eff Conc m => m a -> (Async a -> m b) -> m b Source #

withAsyncWithUnmask :: Eff Conc m => ((forall x. m x -> m x) -> m a) -> (Async a -> m b) -> m b Source #

withAsyncOnWithUnmask :: Eff Conc m => Int -> ((forall x. m x -> m x) -> m a) -> (Async a -> m b) -> m b Source #

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

cancel :: Eff Conc m => Async a -> m () Source #

uninterruptibleCancel :: Eff Conc m => Async a -> m () Source #

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

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

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

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

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

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

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

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

linkOnly :: Eff Conc m => (SomeException -> Bool) -> Async a -> m () Source #

link2Only :: Eff Conc m => (SomeException -> Bool) -> Async a -> Async b -> m () Source #

race_ :: Eff Conc m => m a -> m b -> m () Source #

concurrently_ :: Eff Conc m => m a -> m b -> m () Source #

mapConcurrently_ :: (Foldable t, Eff Conc m) => (a -> m b) -> t a -> m () Source #

forConcurrently_ :: (Foldable t, Eff Conc m) => t a -> (a -> m b) -> m () Source #

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

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

Re-exports from Control.Concurrent.Async

asyncThreadId :: Async a -> ThreadId #

Returns the ThreadId of the thread running the given Async.

data AsyncCancelled #

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

data ExceptionInLinkedThread #

Constructors

ExceptionInLinkedThread (Async a) SomeException

Instances

Instances details

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

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

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

Since: async-2.1.0

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

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

Since: async-2.1.0

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

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

Since: async-2.1.0

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

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

Since: async-2.1.0

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

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

Since: async-2.1.0

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

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

Since: async-2.1.0

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

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

Carriers

data ConcToIOC m a Source #

Instances

Instances details

MonadTrans ConcToIOC Source #
Instance details Defined in Control.Effect.Internal.Conc Methods lift :: Monad m => m a -> ConcToIOC m a #
MonadBase b m => MonadBase b (ConcToIOC m) Source #
Instance details Defined in Control.Effect.Internal.Conc Methods liftBase :: b α -> ConcToIOC m α #
MonadBaseControl b m => MonadBaseControl b (ConcToIOC m) Source #
Instance details Defined in Control.Effect.Internal.Conc Associated Types type StM (ConcToIOC m) a # Methods liftBaseWith :: (RunInBase (ConcToIOC m) b -> b a) -> ConcToIOC m a # restoreM :: StM (ConcToIOC m) a -> ConcToIOC m a #
Monad m => Monad (ConcToIOC m) Source #
Instance details Defined in Control.Effect.Internal.Conc Methods (>>=) :: ConcToIOC m a -> (a -> ConcToIOC m b) -> ConcToIOC m b # (>>) :: ConcToIOC m a -> ConcToIOC m b -> ConcToIOC m b # return :: a -> ConcToIOC m a #
Functor m => Functor (ConcToIOC m) Source #
Instance details Defined in Control.Effect.Internal.Conc Methods fmap :: (a -> b) -> ConcToIOC m a -> ConcToIOC m b # (<$) :: a -> ConcToIOC m b -> ConcToIOC m a #
MonadFix m => MonadFix (ConcToIOC m) Source #
Instance details Defined in Control.Effect.Internal.Conc Methods mfix :: (a -> ConcToIOC m a) -> ConcToIOC m a #
MonadFail m => MonadFail (ConcToIOC m) Source #
Instance details Defined in Control.Effect.Internal.Conc Methods fail :: String -> ConcToIOC m a #
Applicative m => Applicative (ConcToIOC m) Source #
Instance details Defined in Control.Effect.Internal.Conc Methods pure :: a -> ConcToIOC m a # (<>) :: ConcToIOC m (a -> b) -> ConcToIOC m a -> ConcToIOC m b # liftA2 :: (a -> b -> c) -> ConcToIOC m a -> ConcToIOC m b -> ConcToIOC m c # (>) :: ConcToIOC m a -> ConcToIOC m b -> ConcToIOC m b # (<*) :: ConcToIOC m a -> ConcToIOC m b -> ConcToIOC m a #
MonadIO m => MonadIO (ConcToIOC m) Source #
Instance details Defined in Control.Effect.Internal.Conc Methods liftIO :: IO a -> ConcToIOC m a #
Alternative m => Alternative (ConcToIOC m) Source #
Instance details Defined in Control.Effect.Internal.Conc Methods empty :: ConcToIOC m a # (<\|>) :: ConcToIOC m a -> ConcToIOC m a -> ConcToIOC m a # some :: ConcToIOC m a -> ConcToIOC m [a] # many :: ConcToIOC m a -> ConcToIOC m [a] #
MonadPlus m => MonadPlus (ConcToIOC m) Source #
Instance details Defined in Control.Effect.Internal.Conc Methods mzero :: ConcToIOC m a # mplus :: ConcToIOC m a -> ConcToIOC m a -> ConcToIOC m a #
MonadThrow m => MonadThrow (ConcToIOC m) Source #
Instance details Defined in Control.Effect.Internal.Conc Methods throwM :: Exception e => e -> ConcToIOC m a #
MonadCatch m => MonadCatch (ConcToIOC m) Source #
Instance details Defined in Control.Effect.Internal.Conc Methods catch :: Exception e => ConcToIOC m a -> (e -> ConcToIOC m a) -> ConcToIOC m a #
MonadMask m => MonadMask (ConcToIOC m) Source #
Instance details Defined in Control.Effect.Internal.Conc Methods mask :: ((forall a. ConcToIOC m a -> ConcToIOC m a) -> ConcToIOC m b) -> ConcToIOC m b # uninterruptibleMask :: ((forall a. ConcToIOC m a -> ConcToIOC m a) -> ConcToIOC m b) -> ConcToIOC m b # generalBracket :: ConcToIOC m a -> (a -> ExitCase b -> ConcToIOC m c) -> (a -> ConcToIOC m b) -> ConcToIOC m (b, c) #
(Carrier m, MonadBaseControlPure IO m) => Carrier (ConcToIOC m) Source #
Instance details Defined in Control.Effect.Internal.Conc Associated Types type Derivs (ConcToIOC m) :: [Effect] Source # type Prims (ConcToIOC m) :: [Effect] Source # Methods algPrims :: Algebra' (Prims (ConcToIOC m)) (ConcToIOC m) a Source # reformulate :: Monad z => Reformulation' (Derivs (ConcToIOC m)) (Prims (ConcToIOC m)) (ConcToIOC m) z a Source # algDerivs :: Algebra' (Derivs (ConcToIOC m)) (ConcToIOC m) a Source #
type Derivs (ConcToIOC m) Source #
Instance details Defined in Control.Effect.Internal.Conc type Derivs (ConcToIOC m) = Derivs (UnwrapTopC Conc (UnliftToFinalC IO m))
type Prims (ConcToIOC m) Source #
Instance details Defined in Control.Effect.Internal.Conc type Prims (ConcToIOC m) = Prims (UnwrapTopC Conc (UnliftToFinalC IO m))
type StM (ConcToIOC m) a Source #
Instance details Defined in Control.Effect.Internal.Conc type StM (ConcToIOC m) a = StM (UnwrapTopC Conc (UnliftToFinalC IO m)) a

type ConcToUnliftIOC = UnwrapC Conc Source #