Control.TimeWarp.Manager.Job

This module provides abstractions for parallel job processing.

Job data types

data InterruptType

Defines way to interrupt all jobs in curator.

Constructors

Plain

Just interrupt all jobs

Force

Interrupt all jobs, and treat them all as completed

WithTimeout !Microsecond !(IO ())

Interrupt all jobs in Plain was, but if some jobs fail to complete in time, interrupt Forcely and execute given action.

newtype JobCurator

Keeps set of jobs. Allows to stop jobs and wait till all of them finish.

Constructors

JobCurator

Fields

• getJobCurator :: TVar JobCuratorState

JobsState lenses

jcCounter :: Lens' JobCuratorState JobId

jcIsClosed :: Lens' JobCuratorState Bool

jcJobs :: Lens' JobCuratorState (HashMap JobId JobInterrupter)

Manager utilities

addManagerAsJob :: (MonadIO m, MonadTimed m, MonadBaseControl IO m) => JobCurator -> InterruptType -> JobCurator -> m ()

Add second manager as a job to first manager.

addSafeThreadJob :: (MonadIO m, MonadMask m, MonadTimed m) => JobCurator -> m () -> m ()

Adds job executing in another thread, interrupting does nothing. Usefull then work stops itself on interrupt, and we just need to wait till it fully stops.

addThreadJob :: (CanLog m, MonadIO m, MonadMask m, MonadTimed m, MonadBaseControl IO m) => JobCurator -> m () -> m ()

Adds job executing in another thread, where interrupting kills the thread.

interruptAllJobs :: MonadIO m => JobCurator -> InterruptType -> m ()

Invokes JobInterrupters for all incompleted jobs. Has no effect on second call.

isInterrupted :: MonadIO m => JobCurator -> m Bool

mkJobCurator :: MonadIO m => m JobCurator

stopAllJobs :: MonadIO m => JobCurator -> m ()

Interrupts and then awaits for all jobs to complete.

unlessInterrupted :: MonadIO m => JobCurator -> m () -> m ()