Safe Haskell	Safe-Inferred
Language	Haskell2010

Control.Concurrent.JobPool

Description

This module allows the management of a multiple Async jobs which are grouped by an 'Ord group => group' type.

Synopsis

data JobPool group m a
data Job group m a = Job (m a) (SomeException → m a) group String
withJobPool ∷ ∀ group m a b. (MonadAsync m, MonadThrow m, MonadLabelledSTM m) ⇒ (JobPool group m a → m b) → m b
forkJob ∷ ∀ group m a. (MonadAsync m, MonadMask m, Ord group) ⇒ JobPool group m a → Job group m a → m ()
readSize ∷ MonadSTM m ⇒ JobPool group m a → STM m Int
readGroupSize ∷ (MonadSTM m, Eq group) ⇒ JobPool group m a → group → STM m Int
waitForJob ∷ MonadSTM m ⇒ JobPool group m a → STM m a
cancelGroup ∷ (MonadAsync m, Eq group) ⇒ JobPool group m a → group → m ()

Documentation

data JobPool group m a Source #

JobPool allows to submit asynchronous jobs, wait for their completion or cancel. Jobs are grouped, each group can be cancelled separately.

data Job group m a Source #

An asynchronous job which belongs to some group and its exception handler.

Constructors

Job
Fields (m a) job (SomeException → m a) error handler group job group String thread label

withJobPool ∷ ∀ group m a b. (MonadAsync m, MonadThrow m, MonadLabelledSTM m) ⇒ (JobPool group m a → m b) → m b Source #

forkJob ∷ ∀ group m a. (MonadAsync m, MonadMask m, Ord group) ⇒ JobPool group m a → Job group m a → m () Source #

readGroupSize ∷ (MonadSTM m, Eq group) ⇒ JobPool group m a → group → STM m Int Source #

Wait for next successfully completed job. Unlike wait it will not throw if a job errors.

cancelGroup ∷ (MonadAsync m, Eq group) ⇒ JobPool group m a → group → m () Source #

Cancel all threads in a given group. Blocks until all threads terminated.