Control.Effect.Conc

Interface adapted from Control.Concurrent.Async

Effects

data Conc m a

An effect for concurrent execution.

Instances

EffNewtype Conc

Defined in Control.Effect.Conc

Associated Types

type UnwrappedEff Conc :: Effect

Methods

unwrapped :: Conc z x -> UnwrappedEff Conc z x

type UnwrappedEff Conc

Defined in Control.Effect.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

Functor Async

Defined in Control.Concurrent.Async

Methods

fmap :: (a -> b) -> Async a -> Async b

(<$) :: a -> Async b -> Async a

Eq (Async a)

Defined in Control.Concurrent.Async

Methods

(==) :: Async a -> Async a -> Bool

(/=) :: Async a -> Async a -> Bool

Ord (Async a)

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)

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

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

Transform a Conc effect into Unlift IO.

Key actions

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)

Concurrently applicative

newtype Concurrently m a

Constructors

Concurrently

Fields

• runConcurrently :: m a

Instances

Functor m => Functor (Concurrently m)

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)

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)

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)

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)

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)

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

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

Eq AsyncCancelled

Defined in Control.Concurrent.Async

Methods

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

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

Show AsyncCancelled

Defined in Control.Concurrent.Async

Methods

showsPrec :: Int -> AsyncCancelled -> ShowS

show :: AsyncCancelled -> String

showList :: [AsyncCancelled] -> ShowS

Exception AsyncCancelled

Defined in Control.Concurrent.Async

Methods

toException :: AsyncCancelled -> SomeException

fromException :: SomeException -> Maybe AsyncCancelled

displayException :: AsyncCancelled -> String

data ExceptionInLinkedThread where

Constructors

ExceptionInLinkedThread :: forall a. Async a -> SomeException -> ExceptionInLinkedThread

Instances

Show ExceptionInLinkedThread

Defined in Control.Concurrent.Async

Methods

showsPrec :: Int -> ExceptionInLinkedThread -> ShowS

show :: ExceptionInLinkedThread -> String

showList :: [ExceptionInLinkedThread] -> ShowS

Exception ExceptionInLinkedThread

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

type ConcToIOC = CompositionC '[UnwrapTopC Conc, UnliftToFinalC IO]

type ConcToUnliftIOC = UnwrapC Conc