Faktory.Job

Documentation

data Job arg

Instances

Generic (Job arg)

Defined in Faktory.Job

Associated Types

type Rep (Job arg) :: Type -> Type

Methods

from :: Job arg -> Rep (Job arg) x

to :: Rep (Job arg) x -> Job arg

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

FromJSON args => FromJSON (Job args)

Defined in Faktory.Job

Methods

parseJSON :: Value -> Parser (Job args)

parseJSONList :: Value -> Parser [Job args]

type Rep (Job arg)

Defined in Faktory.Job

type Rep (Job arg) = D1 (MetaData "Job" "Faktory.Job" "faktory-1.0.1.3-B4pL0PsFhGgAyBxztkp0Ni" False) (C1 (MetaCons "Job" PrefixI True) ((S1 (MetaSel (Just "jobJid") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JobId) :*: (S1 (MetaSel (Just "jobJobtype") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "jobArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (NonEmpty arg)))) :*: (S1 (MetaSel (Just "jobRetry") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int)) :*: (S1 (MetaSel (Just "jobQueue") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Queue)) :*: S1 (MetaSel (Just "jobAt") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe UTCTime))))))

type JobId = String

data JobOptions

Options for the execution of a job

See perform for more details.

Instances

Semigroup JobOptions

Defined in Faktory.Job

Methods

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

sconcat :: NonEmpty JobOptions -> JobOptions

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

Monoid JobOptions

Defined in Faktory.Job

Methods

mempty :: JobOptions

mappend :: JobOptions -> JobOptions -> JobOptions

mconcat :: [JobOptions] -> JobOptions

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

queue :: Queue -> JobOptions

jobtype :: String -> JobOptions

at :: UTCTime -> JobOptions

in_ :: NominalDiffTime -> JobOptions

newJob :: arg -> IO (Job arg)

jobJid :: Job arg -> JobId

jobArg :: Job arg -> arg