Faktory.Job

Documentation

data Job arg

Instances

FromJSON args => FromJSON (Job args)

Defined in Faktory.Job

Methods

parseJSON :: Value -> Parser (Job args)

parseJSONList :: Value -> Parser [Job args]

ToJSON args => ToJSON (Job args)

Defined in Faktory.Job

Methods

toJSON :: Job args -> Value

toEncoding :: Job args -> Encoding

toJSONList :: [Job args] -> Value

toEncodingList :: [Job args] -> Encoding

type JobId = String

data JobOptions

Options for the execution of a job

These can be constructed using (<>):

let options = retry 1 <> jobtype MyJob

To enqueue with defaults, use mempty.

Options use Last semantics, so (e.g.) retry x <> will set retries to x only if not already set, and <> retry x will override any already-present retries to x.

Instances

FromJSON JobOptions

Defined in Faktory.JobOptions

Methods

parseJSON :: Value -> Parser JobOptions

parseJSONList :: Value -> Parser [JobOptions]

Monoid JobOptions

Defined in Faktory.JobOptions

Methods

mempty :: JobOptions

mappend :: JobOptions -> JobOptions -> JobOptions

mconcat :: [JobOptions] -> JobOptions

Semigroup JobOptions

Defined in Faktory.JobOptions

Methods

(<>) :: JobOptions -> JobOptions -> JobOptions

sconcat :: NonEmpty JobOptions -> JobOptions

stimes :: Integral b => b -> JobOptions -> JobOptions

Generic JobOptions

Defined in Faktory.JobOptions

Associated Types

type Rep JobOptions :: Type -> Type

Methods

from :: JobOptions -> Rep JobOptions x

to :: Rep JobOptions x -> JobOptions

Show JobOptions

Defined in Faktory.JobOptions

Methods

showsPrec :: Int -> JobOptions -> ShowS

show :: JobOptions -> String

showList :: [JobOptions] -> ShowS

Eq JobOptions

Defined in Faktory.JobOptions

Methods

(==) :: JobOptions -> JobOptions -> Bool

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

type Rep JobOptions

Defined in Faktory.JobOptions

type Rep JobOptions = D1 ('MetaData "JobOptions" "Faktory.JobOptions" "faktory-1.1.2.5-7KtnMY0SAdp6uhULWnDFgZ" 'False) (C1 ('MetaCons "JobOptions" 'PrefixI 'True) ((S1 ('MetaSel ('Just "joJobtype") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Last String))) :*: (S1 ('MetaSel ('Just "joRetry") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Last Int))) :*: S1 ('MetaSel ('Just "joQueue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Last Queue))))) :*: (S1 ('MetaSel ('Just "joSchedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Last (Either UTCTime NominalDiffTime)))) :*: (S1 ('MetaSel ('Just "joCustom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Custom)) :*: S1 ('MetaSel ('Just "joReserveFor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Last Natural)))))))

perform :: (HasCallStack, ToJSON arg) => JobOptions -> Producer -> arg -> IO JobId

Perform a Job with the given options

perform mempty SomeJob
perform (queue SomeQueue) SomeJob
perform once SomeJob
perform (at someTime <> once) SomeJob
perform (in_ 10 <> once) SomeJob
perform (in_ 10 <> retry 3) SomeJob

retry :: Int -> JobOptions

once :: JobOptions

Equivalent to retry (-1): no retries, and move to Dead on failure

reserveFor :: Natural -> JobOptions

queue :: Queue -> JobOptions

jobtype :: String -> JobOptions

at :: UTCTime -> JobOptions

in_ :: NominalDiffTime -> JobOptions

custom :: ToJSON a => a -> JobOptions

buildJob :: JobOptions -> Producer -> arg -> IO (Job arg)

Construct a Job and apply options and Producer settings

newJob :: arg -> IO (Job arg)

Construct a Job with default JobOptions

jobJid :: Job arg -> JobId

jobArg :: Job arg -> arg

jobOptions :: Job arg -> JobOptions

jobRetriesRemaining :: Job arg -> Int

jobReserveForMicroseconds :: Job arg -> Int