Faktory.Settings

Documentation

data Settings

Constructors

Settings

Fields

• settingsConnection :: ConnectionInfo
• settingsLogDebug :: String -> IO ()
• settingsLogError :: String -> IO ()
• settingsDefaultJobOptions :: JobOptions

defaultSettings :: Settings

envSettings :: IO Settings

Defaults, but read Connection from the environment

See envConnection

Worker

data WorkerSettings

Constructors

WorkerSettings

Fields

• settingsQueue :: Queue
• settingsId :: Maybe WorkerId
• settingsIdleDelay :: Int
• settingsOnFailed :: SomeException -> IO ()

defaultWorkerSettings :: WorkerSettings

envWorkerSettings :: IO WorkerSettings

newtype Queue

Constructors

Queue Text

Instances

FromJSON Queue

Defined in Faktory.Settings.Queue

Methods

parseJSON :: Value -> Parser Queue

parseJSONList :: Value -> Parser [Queue]

omittedField :: Maybe Queue

ToJSON Queue

Defined in Faktory.Settings.Queue

Methods

toJSON :: Queue -> Value

toEncoding :: Queue -> Encoding

toJSONList :: [Queue] -> Value

toEncodingList :: [Queue] -> Encoding

omitField :: Queue -> Bool

IsString Queue

Defined in Faktory.Settings.Queue

Methods

fromString :: String -> Queue

Show Queue

Defined in Faktory.Settings.Queue

Methods

showsPrec :: Int -> Queue -> ShowS

show :: Queue -> String

showList :: [Queue] -> ShowS

Eq Queue

Defined in Faktory.Settings.Queue

Methods

(==) :: Queue -> Queue -> Bool

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

namespaceQueue :: Namespace -> Queue -> Queue

queueArg :: Queue -> ByteString

defaultQueue :: Queue

data WorkerId

Instances

FromJSON WorkerId

Defined in Faktory.Settings

Methods

parseJSON :: Value -> Parser WorkerId

parseJSONList :: Value -> Parser [WorkerId]

omittedField :: Maybe WorkerId

ToJSON WorkerId

Defined in Faktory.Settings

Methods

toJSON :: WorkerId -> Value

toEncoding :: WorkerId -> Encoding

toJSONList :: [WorkerId] -> Value

toEncodingList :: [WorkerId] -> Encoding

omitField :: WorkerId -> Bool

randomWorkerId :: IO WorkerId

Pool

data PoolSettings

Since: 1.1.3.0

Constructors

PoolSettings

Fields

• settingsSize :: Natural

  Maximum pool size

  Default is 10. Smallest acceptable value is 1. Note that, due to the striping behavior of resource-pool, a configured size N may result in N - 1 resources.

• settingsTimeout :: Natural

  How long before destroying a resource, in seconds

  Default is 600.

envPoolSettings :: IO PoolSettings

Read PoolSettings from the environment

• FAKTORY_POOL_SIZE

• FAKTORY_POOL_TIMEOUT

Since: 1.1.3.0

Re-exports

data ConnectionInfo

Constructors

ConnectionInfo

Fields

• connectionInfoTls :: Bool
• connectionInfoPassword :: Maybe String
• connectionInfoHostName :: HostName
• connectionInfoPort :: PortNumber
• connectionInfoNamespace :: Namespace

Instances

Show ConnectionInfo

Defined in Faktory.Connection

Methods

showsPrec :: Int -> ConnectionInfo -> ShowS

show :: ConnectionInfo -> String

showList :: [ConnectionInfo] -> ShowS

Eq ConnectionInfo

Defined in Faktory.Connection

Methods

(==) :: ConnectionInfo -> ConnectionInfo -> Bool

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

newtype Namespace

Constructors

Namespace Text

Instances

Show Namespace

Defined in Faktory.Connection

Methods

showsPrec :: Int -> Namespace -> ShowS

show :: Namespace -> String

showList :: [Namespace] -> ShowS

Eq Namespace

Defined in Faktory.Connection

Methods

(==) :: Namespace -> Namespace -> Bool

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