Faktory.Ent.Tracking

Support for the TRACK command (Enterprise only)

https://github.com/contribsys/faktory/wiki/Ent-Tracking

Documentation

newtype CustomTrack

Constructors

CustomTrack

Fields

• track :: Int

Instances

Generic CustomTrack

Defined in Faktory.Ent.Tracking

Associated Types

type Rep CustomTrack :: Type -> Type

Methods

from :: CustomTrack -> Rep CustomTrack x

to :: Rep CustomTrack x -> CustomTrack

ToJSON CustomTrack

Defined in Faktory.Ent.Tracking

Methods

toJSON :: CustomTrack -> Value

toEncoding :: CustomTrack -> Encoding

toJSONList :: [CustomTrack] -> Value

toEncodingList :: [CustomTrack] -> Encoding

type Rep CustomTrack

Defined in Faktory.Ent.Tracking

type Rep CustomTrack = D1 ('MetaData "CustomTrack" "Faktory.Ent.Tracking" "faktory-1.1.2.3-B57t8FT30W1366lrMRTe3J" 'True) (C1 ('MetaCons "CustomTrack" 'PrefixI 'True) (S1 ('MetaSel ('Just "track") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

tracked :: JobOptions

trackPerform :: (HasCallStack, ToJSON arg) => JobOptions -> Producer -> arg -> IO JobId

Deprecated: Use ‘perform (options <> tracked)’ instead

perform, but adding { custom: { track: 1 } }

Equivalent to:

perform (custom $ CustomTrack 1)

data JobDetails

Constructors

JobDetails

Fields

• jdJid :: JobId
• jdPercent :: Maybe Int
• jdDesc :: Maybe Text
• jdState :: JobState
• jdUpdatedAt :: Maybe UTCTime

Instances

Generic JobDetails

Defined in Faktory.Ent.Tracking

Associated Types

type Rep JobDetails :: Type -> Type

Methods

from :: JobDetails -> Rep JobDetails x

to :: Rep JobDetails x -> JobDetails

FromJSON JobDetails

Defined in Faktory.Ent.Tracking

Methods

parseJSON :: Value -> Parser JobDetails

parseJSONList :: Value -> Parser [JobDetails]

type Rep JobDetails

Defined in Faktory.Ent.Tracking

type Rep JobDetails = D1 ('MetaData "JobDetails" "Faktory.Ent.Tracking" "faktory-1.1.2.3-B57t8FT30W1366lrMRTe3J" 'False) (C1 ('MetaCons "JobDetails" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jdJid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JobId) :*: S1 ('MetaSel ('Just "jdPercent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "jdDesc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jdState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JobState) :*: S1 ('MetaSel ('Just "jdUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe UTCTime))))))

data JobState

Constructors

JobStateUnknown

JobStateEnqueued

JobStateWorking

JobStateSuccess

JobStateFailed

JobStateDead

Instances

Bounded JobState

Defined in Faktory.JobState

Methods

minBound :: JobState

maxBound :: JobState

Enum JobState

Defined in Faktory.JobState

Methods

succ :: JobState -> JobState

pred :: JobState -> JobState

toEnum :: Int -> JobState

fromEnum :: JobState -> Int

enumFrom :: JobState -> [JobState]

enumFromThen :: JobState -> JobState -> [JobState]

enumFromTo :: JobState -> JobState -> [JobState]

enumFromThenTo :: JobState -> JobState -> JobState -> [JobState]

Eq JobState

Defined in Faktory.JobState

Methods

(==) :: JobState -> JobState -> Bool

(/=) :: JobState -> JobState -> Bool

Show JobState

Defined in Faktory.JobState

Methods

showsPrec :: Int -> JobState -> ShowS

show :: JobState -> String

showList :: [JobState] -> ShowS

ToJSON JobState

Defined in Faktory.JobState

Methods

toJSON :: JobState -> Value

toEncoding :: JobState -> Encoding

toJSONList :: [JobState] -> Value

toEncodingList :: [JobState] -> Encoding

FromJSON JobState

Defined in Faktory.JobState

Methods

parseJSON :: Value -> Parser JobState

parseJSONList :: Value -> Parser [JobState]

trackGet :: Producer -> JobId -> IO (Either String (Maybe JobDetails))

trackGetHush :: Producer -> JobId -> IO JobDetails

trackGet but mask any failures to JobStateUnknown

data SetJobDetails

Constructors

SetJobDetails

Fields

• sjdJid :: JobId
• sjdPercent :: Maybe Int
• sjdDesc :: Maybe Text
• sjdReserveUntil :: Maybe UTCTime

Instances

Generic SetJobDetails

Defined in Faktory.Ent.Tracking

Associated Types

type Rep SetJobDetails :: Type -> Type

Methods

from :: SetJobDetails -> Rep SetJobDetails x

to :: Rep SetJobDetails x -> SetJobDetails

ToJSON SetJobDetails

Defined in Faktory.Ent.Tracking

Methods

toJSON :: SetJobDetails -> Value

toEncoding :: SetJobDetails -> Encoding

toJSONList :: [SetJobDetails] -> Value

toEncodingList :: [SetJobDetails] -> Encoding

type Rep SetJobDetails

Defined in Faktory.Ent.Tracking

type Rep SetJobDetails = D1 ('MetaData "SetJobDetails" "Faktory.Ent.Tracking" "faktory-1.1.2.3-B57t8FT30W1366lrMRTe3J" 'False) (C1 ('MetaCons "SetJobDetails" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sjdJid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JobId) :*: S1 ('MetaSel ('Just "sjdPercent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "sjdDesc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sjdReserveUntil") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe UTCTime)))))

trackSet :: HasCallStack => Producer -> SetJobDetails -> IO ()