faktory-1.1.2.7: Faktory Worker for Haskell
Safe HaskellSafe-Inferred
LanguageHaskell2010

Faktory.Job

Synopsis

Documentation

data Job arg Source #

Instances

Instances details
Foldable Job Source # 
Instance details

Defined in Faktory.Job

Methods

fold :: Monoid m => Job m -> m #

foldMap :: Monoid m => (a -> m) -> Job a -> m #

foldMap' :: Monoid m => (a -> m) -> Job a -> m #

foldr :: (a -> b -> b) -> b -> Job a -> b #

foldr' :: (a -> b -> b) -> b -> Job a -> b #

foldl :: (b -> a -> b) -> b -> Job a -> b #

foldl' :: (b -> a -> b) -> b -> Job a -> b #

foldr1 :: (a -> a -> a) -> Job a -> a #

foldl1 :: (a -> a -> a) -> Job a -> a #

toList :: Job a -> [a] #

null :: Job a -> Bool #

length :: Job a -> Int #

elem :: Eq a => a -> Job a -> Bool #

maximum :: Ord a => Job a -> a #

minimum :: Ord a => Job a -> a #

sum :: Num a => Job a -> a #

product :: Num a => Job a -> a #

Traversable Job Source # 
Instance details

Defined in Faktory.Job

Methods

traverse :: Applicative f => (a -> f b) -> Job a -> f (Job b) #

sequenceA :: Applicative f => Job (f a) -> f (Job a) #

mapM :: Monad m => (a -> m b) -> Job a -> m (Job b) #

sequence :: Monad m => Job (m a) -> m (Job a) #

Functor Job Source # 
Instance details

Defined in Faktory.Job

Methods

fmap :: (a -> b) -> Job a -> Job b #

(<$) :: a -> Job b -> Job a #

FromJSON args => FromJSON (Job args) Source # 
Instance details

Defined in Faktory.Job

Methods

parseJSON :: Value -> Parser (Job args) #

parseJSONList :: Value -> Parser [Job args] #

omittedField :: Maybe (Job args) #

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 #

omitField :: Job args -> Bool #

Show arg => Show (Job arg) Source # 
Instance details

Defined in Faktory.Job

Methods

showsPrec :: Int -> Job arg -> ShowS #

show :: Job arg -> String #

showList :: [Job arg] -> ShowS #

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
FromJSON JobOptions Source # 
Instance details

Defined in Faktory.JobOptions

Methods

parseJSON :: Value -> Parser JobOptions #

parseJSONList :: Value -> Parser [JobOptions] #

omittedField :: Maybe JobOptions #

Monoid JobOptions Source # 
Instance details

Defined in Faktory.JobOptions

Methods

mempty :: JobOptions #

mappend :: JobOptions -> JobOptions -> JobOptions #

mconcat :: [JobOptions] -> JobOptions #

Semigroup JobOptions Source # 
Instance details

Defined in Faktory.JobOptions

Methods

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

sconcat :: NonEmpty JobOptions -> JobOptions #

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

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 #

Show JobOptions Source # 
Instance details

Defined in Faktory.JobOptions

Methods

showsPrec :: Int -> JobOptions -> ShowS #

show :: JobOptions -> String #

showList :: [JobOptions] -> ShowS #

Eq JobOptions Source # 
Instance details

Defined in Faktory.JobOptions

Methods

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

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

type Rep JobOptions Source # 
Instance details

Defined in Faktory.JobOptions

type Rep JobOptions = D1 ('MetaData "JobOptions" "Faktory.JobOptions" "faktory-1.1.2.7-2ueK9WlYC3nL6yjpm69v98" '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 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

reserveFor :: Natural -> JobOptions Source #

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 #

jobOptions :: Job arg -> JobOptions Source #

jobRetriesRemaining :: Job arg -> Int Source #

jobReserveForMicroseconds :: Job arg -> Int Source #