Control.Monad.Scoped.Async

Functions and types for safely working with Asyncs in Scoped blocks

Scoped Async

type ScopedAsync s a = ScopedResource s (Async a)

Just like Async but bound to a Scoped block

Allocating a new ScopedAsync in a Scoped block

async :: MonadUnliftIO m => m a -> Scoped s m (ScopedAsync s a)

Run an IO action asynchronously in a Scoped block. When the Scoped block ends, the Async is cancelled

asyncBound :: MonadUnliftIO m => m a -> Scoped s m (ScopedAsync s a)

Like async but uses forkOS internally

Waiting for a ScopedAsync to finish

wait :: MonadIO m => ScopedAsync s a -> Scoped s m a

Wait for the ScopedAsync to finish immediately

waitCatch :: MonadIO m => ScopedAsync s a -> Scoped s m (Either SomeException a)

Like wait but return either Left SomeException or Right a

Waiting for a ScopedAsync to finish as part of the handlers of the Scoped block

waitScoped :: MonadUnliftIO m => ScopedAsync s a -> Scoped s m ()

Like wait but wait as part of the handlers of the Scoped block

waitCatchScoped :: MonadUnliftIO m => ScopedAsync s a -> Scoped s m ()

Like waitCatch but wait as part of the handlers of the Scoped block