Safe Haskell	None
Language	Haskell2010

Faktory.Job

Synopsis

data Job arg
type JobId = String
data JobOptions
perform :: (HasCallStack, ToJSON arg) => JobOptions -> Producer -> arg -> IO JobId
retry :: Int -> JobOptions
once :: 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)
newJob :: arg -> IO (Job arg)
jobJid :: Job arg -> JobId
jobArg :: Job arg -> arg

Documentation

data Job arg Source #

Instances

Instances details

ToJSON args => ToJSON (Job args) Source #
Instance details 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) Source #
Instance details Defined in Faktory.Job Methods parseJSON :: Value -> Parser (Job args) # parseJSONList :: Value -> Parser [Job args] #

type JobId = String Source #

data JobOptions Source #

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

Instances details

Generic JobOptions Source #
Instance details Defined in Faktory.JobOptions Associated Types type Rep JobOptions :: Type -> Type # Methods from :: JobOptions -> Rep JobOptions x # to :: Rep JobOptions x -> JobOptions #
Semigroup JobOptions Source #
Instance details Defined in Faktory.JobOptions Methods (<>) :: JobOptions -> JobOptions -> JobOptions # sconcat :: NonEmpty JobOptions -> JobOptions # stimes :: Integral b => b -> JobOptions -> JobOptions #
Monoid JobOptions Source #
Instance details Defined in Faktory.JobOptions Methods mempty :: JobOptions # mappend :: JobOptions -> JobOptions -> JobOptions # mconcat :: [JobOptions] -> JobOptions #
FromJSON JobOptions Source #
Instance details Defined in Faktory.JobOptions Methods parseJSON :: Value -> Parser JobOptions # parseJSONList :: Value -> Parser [JobOptions] #
type Rep JobOptions Source #
Instance details Defined in Faktory.JobOptions type Rep JobOptions = D1 ('MetaData "JobOptions" "Faktory.JobOptions" "faktory-1.0.3.0-9UKSIes7JIyG34AmEZdhHA" '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))))))

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

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 Source #

once :: JobOptions Source #

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

queue :: Queue -> JobOptions Source #

jobtype :: String -> JobOptions Source #

at :: UTCTime -> JobOptions Source #

in_ :: NominalDiffTime -> JobOptions Source #

custom :: ToJSON a => a -> JobOptions Source #

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

Construct a Job and apply options and Producer settings

newJob :: arg -> IO (Job arg) Source #

Construct a Job with default JobOptions

jobJid :: Job arg -> JobId Source #

jobArg :: Job arg -> arg Source #