Safe Haskell	None
Language	Haskell2010

Faktory.JobOptions

Contents

Modifiers
Enqueue-time modifiers

Synopsis

data JobOptions = JobOptions {
- joJobtype :: Maybe (Last String)
- joRetry :: Maybe (Last Int)
- joQueue :: Maybe (Last Queue)
- joSchedule :: Maybe (Last (Either UTCTime NominalDiffTime))
- joCustom :: Maybe Custom
}
retry :: Int -> JobOptions
once :: JobOptions
queue :: Queue -> JobOptions
jobtype :: String -> JobOptions
at :: UTCTime -> JobOptions
in_ :: NominalDiffTime -> JobOptions
custom :: ToJSON a => a -> JobOptions
getAtFromSchedule :: JobOptions -> IO (Maybe UTCTime)
namespaceQueue :: Namespace -> JobOptions -> JobOptions

Documentation

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.

Constructors

JobOptions
Fields joJobtype :: Maybe (Last String) joRetry :: Maybe (Last Int) joQueue :: Maybe (Last Queue) joSchedule :: Maybe (Last (Either UTCTime NominalDiffTime)) joCustom :: Maybe Custom

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.2.0-C4sKz9rDBVhonD7QKQ1Ia" '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))))))

Modifiers

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 #

Enqueue-time modifiers

getAtFromSchedule :: JobOptions -> IO (Maybe UTCTime) Source #

namespaceQueue :: Namespace -> JobOptions -> JobOptions Source #