Database.CQL.IO.Jobs

Documentation

data Jobs k

A registry for asynchronous computations ("jobs") associated with keys of type k, with only a single job running at a time for a particular key.

data JobReplaced

The asynchronous exception used to cancel a job if it is replaced by another job.

Constructors

JobReplaced

Instances

Eq JobReplaced

Defined in Database.CQL.IO.Jobs

Methods

(==) :: JobReplaced -> JobReplaced -> Bool

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

Show JobReplaced

Defined in Database.CQL.IO.Jobs

Methods

showsPrec :: Int -> JobReplaced -> ShowS

show :: JobReplaced -> String

showList :: [JobReplaced] -> ShowS

Exception JobReplaced

Defined in Database.CQL.IO.Jobs

Methods

toException :: JobReplaced -> SomeException

fromException :: SomeException -> Maybe JobReplaced

displayException :: JobReplaced -> String

newJobs :: MonadIO m => m (Jobs k)

runJob :: (MonadIO m, Ord k) => Jobs k -> k -> IO () -> m (Async ())

Run an asynchronous job for a key. If there is a running job for the same key, it is replaced and cancelled with a JobReplaced exception.

runJob_ :: (MonadIO m, Ord k) => Jobs k -> k -> IO () -> m ()

runJob and ignore the result.

tryRunJob :: (MonadIO m, Ord k) => Jobs k -> k -> IO () -> m (Maybe (Async ()))

Try to run an asynchronous job for a key. If there is a running job for the same key, Nothing is returned and the job will not run.

tryRunJob_ :: (MonadIO m, Ord k) => Jobs k -> k -> IO () -> m ()

tryRunJob and ignore the result.

cancelJobs :: MonadIO m => Jobs k -> m ()

Cancel all running jobs.

listJobs :: MonadIO m => Jobs k -> m [(k, Async ())]

List all running jobs.

listJobKeys :: MonadIO m => Jobs k -> m [k]

List the keys of all running jobs.