Safe Haskell	None
Language	Haskell2010

IHP.Job.Types

Synopsis

class Job job where
- perform :: job -> IO ()
- maxAttempts :: Int
- timeoutInMicroseconds :: Maybe Int
- queuePollInterval :: Int
- maxConcurrency :: Int
- backoffStrategy :: BackoffStrategy
data JobWorkerArgs = JobWorkerArgs {
- workerId :: UUID
- modelContext :: ModelContext
- frameworkConfig :: FrameworkConfig
- pgListener :: PGListener
}
newtype JobWorker = JobWorker (JobWorkerArgs -> ResourceT IO JobWorkerProcess)
data JobStatus
class Worker application where
- workers :: application -> [JobWorker]
data JobWorkerProcess = JobWorkerProcess {
- runners :: [(ReleaseKey, Async ())]
- subscription :: Subscription
- pollerReleaseKey :: ReleaseKey
- action :: MVar JobWorkerProcessMessage
}
data JobWorkerProcessMessage
- = JobAvailable
- | Stop
data BackoffStrategy
- = LinearBackoff {
  - delayInSeconds :: !Int
  }
- | ExponentialBackoff {
  - delayInSeconds :: !Int
  }

Documentation

class Job job where Source #

Minimal complete definition

perform

Methods

perform :: job -> IO () Source #

maxAttempts :: Int Source #

timeoutInMicroseconds :: Maybe Int Source #

queuePollInterval :: Int Source #

While jobs are typically fetch using pg_notiy, we have to poll the queue table periodically to catch jobs with a run_at in the future

By default we only poll every minute

maxConcurrency :: Int Source #

How many jobs of this type can be executed at the same time

This limit only applies to the running haskell process. If you run N multiple independent processes of the job runner, the limit will be N * maxConcurrency

backoffStrategy :: BackoffStrategy Source #

data JobWorkerArgs Source #

Constructors

JobWorkerArgs
Fields workerId :: UUID modelContext :: ModelContext frameworkConfig :: FrameworkConfig pgListener :: PGListener

newtype JobWorker Source #

Constructors

JobWorker (JobWorkerArgs -> ResourceT IO JobWorkerProcess)

data JobStatus Source #

Mapping for JOB_STATUS. The DDL statement for this can be found in IHPSchema.sql:

CREATE TYPE JOB_STATUS AS ENUM ('job_status_not_started', 'job_status_running', 'job_status_failed', 'job_status_succeeded', 'job_status_retry');

Constructors

JobStatusNotStarted
JobStatusRunning
JobStatusFailed
JobStatusTimedOut
JobStatusSucceeded
JobStatusRetry

Instances

Instances details

Enum JobStatus Source #
Instance details Defined in IHP.Job.Types Methods succ :: JobStatus -> JobStatus # pred :: JobStatus -> JobStatus # toEnum :: Int -> JobStatus # fromEnum :: JobStatus -> Int # enumFrom :: JobStatus -> [JobStatus] # enumFromThen :: JobStatus -> JobStatus -> [JobStatus] # enumFromTo :: JobStatus -> JobStatus -> [JobStatus] # enumFromThenTo :: JobStatus -> JobStatus -> JobStatus -> [JobStatus] #
Read JobStatus Source #
Instance details Defined in IHP.Job.Types Methods readsPrec :: Int -> ReadS JobStatus # readList :: ReadS [JobStatus] # readPrec :: ReadPrec JobStatus # readListPrec :: ReadPrec [JobStatus] #
Show JobStatus Source #
Instance details Defined in IHP.Job.Types Methods showsPrec :: Int -> JobStatus -> ShowS # show :: JobStatus -> String # showList :: [JobStatus] -> ShowS #
Default JobStatus Source #
Instance details Defined in IHP.Job.Queue Methods def :: JobStatus Source #
Eq JobStatus Source #
Instance details Defined in IHP.Job.Types Methods (==) :: JobStatus -> JobStatus -> Bool # (/=) :: JobStatus -> JobStatus -> Bool #
ParamReader JobStatus Source #
Instance details Defined in IHP.Job.Queue Methods readParameter :: ByteString -> Either ByteString JobStatus Source # readParameterJSON :: Value -> Either ByteString JobStatus Source #
InputValue JobStatus Source #
Instance details Defined in IHP.Job.Queue Methods inputValue :: JobStatus -> Text Source #
FromField JobStatus Source #	Mapping for `JOB_STATUS`: CREATE TYPE JOB_STATUS AS ENUM ('job_status_not_started', 'job_status_running', 'job_status_failed', 'job_status_succeeded', 'job_status_retry');
Instance details Defined in IHP.Job.Queue Methods fromField :: FieldParser JobStatus Source #
ToField JobStatus Source #	Mapping for `JOB_STATUS`: CREATE TYPE JOB_STATUS AS ENUM ('job_status_not_started', 'job_status_running', 'job_status_failed', 'job_status_succeeded', 'job_status_retry');
Instance details Defined in IHP.Job.Queue Methods toField :: JobStatus -> Action Source #

class Worker application where Source #

Methods

workers :: application -> [JobWorker] Source #

data JobWorkerProcess Source #

Constructors

JobWorkerProcess
Fields runners :: [(ReleaseKey, Async ())] subscription :: Subscription pollerReleaseKey :: ReleaseKey action :: MVar JobWorkerProcessMessage

data JobWorkerProcessMessage Source #

Constructors

JobAvailable
Stop

data BackoffStrategy Source #

Constructors

LinearBackoff
Fields delayInSeconds :: !Int
ExponentialBackoff
Fields delayInSeconds :: !Int

Instances

Instances details

Show BackoffStrategy Source #
Instance details Defined in IHP.Job.Types Methods showsPrec :: Int -> BackoffStrategy -> ShowS # show :: BackoffStrategy -> String # showList :: [BackoffStrategy] -> ShowS #
Eq BackoffStrategy Source #
Instance details Defined in IHP.Job.Types Methods (==) :: BackoffStrategy -> BackoffStrategy -> Bool # (/=) :: BackoffStrategy -> BackoffStrategy -> Bool #