Faktory.Pool

Documentation

data FaktoryPool

Since: 1.1.3.0

Instances

HasFaktoryPool FaktoryPool

Defined in Faktory.Pool

Methods

faktoryPoolL :: Lens' FaktoryPool FaktoryPool

class HasFaktoryPool env where

Since: 1.1.3.0

Methods

faktoryPoolL :: Lens' env FaktoryPool

Instances

HasFaktoryPool FaktoryPool

Defined in Faktory.Pool

Methods

faktoryPoolL :: Lens' FaktoryPool FaktoryPool

Pool Construction

data Settings

data PoolSettings

Since: 1.1.3.0

newFaktoryPool :: MonadIO m => Settings -> PoolSettings -> m FaktoryPool

Build a FaktoryPool with the given settings

See Settings, envSettings, PoolSettings, and envPoolSettings.

Since: 1.1.3.0

Pool use

perform :: (MonadUnliftIO m, MonadReader env m, HasFaktoryPool env, ToJSON arg, HasCallStack) => JobOptions -> arg -> m JobId

perform but using a Producer from the pool

Since: 1.1.3.0

buildJob :: (MonadUnliftIO m, MonadReader env m, HasFaktoryPool env) => JobOptions -> arg -> m (Job arg)

buildJob but using a Producer from the pool

Since: 1.1.3.0

Direct access

withProducer :: (MonadUnliftIO m, MonadReader env m, HasFaktoryPool env) => (Producer -> m a) -> m a

Acquire a Producer, use it, and return it to the pool

Since: 1.1.3.0

takeProducer :: (MonadIO m, MonadReader env m, HasFaktoryPool env) => m (Producer, m ())

Get a Producer from the pool along with an action to return it

You should prefer withProducer if at all possible. With this function you are responsible to ensure the return action is called (e.g. with finally).

This is only necessary if you are operating in a monad that doesn't have MonadUnliftIO (like ConduitT), so you need to take and return a Producer separately (e.g. with bracketP).

Since: 1.1.3.0

Re-exports

data Job arg

Instances

Foldable Job

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

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

Defined in Faktory.Job

Methods

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

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

FromJSON args => FromJSON (Job args)

Defined in Faktory.Job

Methods

parseJSON :: Value -> Parser (Job args)

parseJSONList :: Value -> Parser [Job args]

omittedField :: Maybe (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

omitField :: Job args -> Bool

Show arg => Show (Job arg)

Defined in Faktory.Job

Methods

showsPrec :: Int -> Job arg -> ShowS

show :: Job arg -> String

showList :: [Job arg] -> ShowS

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]

omittedField :: Maybe 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.3.1-GGQYa7YkawWCPQciSNip35" '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)))))))

type JobId = String

once :: JobOptions

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

retry :: Int -> JobOptions

at :: UTCTime -> JobOptions

queue :: Queue -> JobOptions

custom :: ToJSON a => a -> JobOptions

reserveFor :: Natural -> JobOptions

jobtype :: String -> JobOptions

in_ :: NominalDiffTime -> JobOptions

newJob :: arg -> IO (Job arg)

Construct a Job with default JobOptions

jobArg :: Job arg -> arg

jobRetriesRemaining :: Job arg -> Int

jobReserveForMicroseconds :: Job arg -> Int