Web.Spock.Worker

Worker

data WorkQueue a

The queue containing scheduled jobs

type WorkHandler conn sess st a = a -> ErrorT InternalError (WebStateM conn sess st) WorkResult

Describe how you want jobs in the queue to be performed

newWorker :: Int -> WorkHandler conn sess st a -> ErrorHandler a -> SpockM conn sess st (WorkQueue a)

Create a new background worker and limit the size of the job queue.

addWork :: MonadIO m => WorkExecution -> a -> WorkQueue a -> m ()

Add a new job to the background worker. If the queue is full this will block

data WorkExecution

Describes when a job should be executed

Constructors

WorkNow

WorkIn NominalDiffTime

WorkAt UTCTime

data WorkResult

Describes the outcome of a job after completion. You can repeat jobs

Constructors

WorkComplete

WorkError

WorkRepeatIn NominalDiffTime

WorkRepeatAt UTCTime

Instances

Eq WorkResult

Show WorkResult

Error Handeling

type ErrorHandler a = InternalError -> a -> IO WorkResult

Describe how you want to handle errors. Make sure you catch all exceptions that can happen inside this handler, otherwise the worker will crash!

type InternalError = String