Safe Haskell	Safe-Inferred
Language	Haskell2010

Faktory.Settings

Contents

Worker
Pool
Re-exports

Synopsis

data Settings = Settings {
- settingsConnection :: ConnectionInfo
- settingsLogDebug :: String -> IO ()
- settingsLogError :: String -> IO ()
- settingsDefaultJobOptions :: JobOptions
}
defaultSettings :: Settings
envSettings :: IO Settings
data WorkerSettings = WorkerSettings {
- settingsQueue :: Queue
- settingsId :: Maybe WorkerId
- settingsIdleDelay :: Int
- settingsOnFailed :: SomeException -> IO ()
}
defaultWorkerSettings :: WorkerSettings
envWorkerSettings :: IO WorkerSettings
newtype Queue = Queue Text
namespaceQueue :: Namespace -> Queue -> Queue
queueArg :: Queue -> ByteString
defaultQueue :: Queue
data WorkerId
randomWorkerId :: IO WorkerId
data PoolSettings = PoolSettings {
- settingsSize :: Natural
- settingsTimeout :: Natural
}
envPoolSettings :: IO PoolSettings
data ConnectionInfo = ConnectionInfo {
}
newtype Namespace = Namespace Text

Documentation

data Settings Source #

Constructors

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

defaultSettings :: Settings Source #

envSettings :: IO Settings Source #

Defaults, but read Connection from the environment

See envConnection

Worker

data WorkerSettings Source #

Constructors

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

defaultWorkerSettings :: WorkerSettings Source #

envWorkerSettings :: IO WorkerSettings Source #

newtype Queue Source #

Constructors

Queue Text

Instances

Instances details

FromJSON Queue Source #
Instance details Defined in Faktory.Settings.Queue Methods parseJSON :: Value -> Parser Queue # parseJSONList :: Value -> Parser [Queue] # omittedField :: Maybe Queue #
ToJSON Queue Source #
Instance details Defined in Faktory.Settings.Queue Methods toJSON :: Queue -> Value # toEncoding :: Queue -> Encoding # toJSONList :: [Queue] -> Value # toEncodingList :: [Queue] -> Encoding # omitField :: Queue -> Bool #
IsString Queue Source #
Instance details Defined in Faktory.Settings.Queue Methods fromString :: String -> Queue #
Show Queue Source #
Instance details Defined in Faktory.Settings.Queue Methods showsPrec :: Int -> Queue -> ShowS # show :: Queue -> String # showList :: [Queue] -> ShowS #
Eq Queue Source #
Instance details Defined in Faktory.Settings.Queue Methods (==) :: Queue -> Queue -> Bool # (/=) :: Queue -> Queue -> Bool #

namespaceQueue :: Namespace -> Queue -> Queue Source #

queueArg :: Queue -> ByteString Source #

defaultQueue :: Queue Source #

data WorkerId Source #

Instances

Instances details

FromJSON WorkerId Source #
Instance details Defined in Faktory.Settings Methods parseJSON :: Value -> Parser WorkerId # parseJSONList :: Value -> Parser [WorkerId] # omittedField :: Maybe WorkerId #
ToJSON WorkerId Source #
Instance details Defined in Faktory.Settings Methods toJSON :: WorkerId -> Value # toEncoding :: WorkerId -> Encoding # toJSONList :: [WorkerId] -> Value # toEncodingList :: [WorkerId] -> Encoding # omitField :: WorkerId -> Bool #

randomWorkerId :: IO WorkerId Source #

Pool

data PoolSettings Source #

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 Source #

Read PoolSettings from the environment

```
FAKTORY_POOL_SIZE
```
```
FAKTORY_POOL_TIMEOUT
```

Since: 1.1.3.0

Re-exports

data ConnectionInfo Source #

Constructors

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

Instances

Instances details

Show ConnectionInfo Source #
Instance details Defined in Faktory.Connection Methods showsPrec :: Int -> ConnectionInfo -> ShowS # show :: ConnectionInfo -> String # showList :: [ConnectionInfo] -> ShowS #
Eq ConnectionInfo Source #
Instance details Defined in Faktory.Connection Methods (==) :: ConnectionInfo -> ConnectionInfo -> Bool # (/=) :: ConnectionInfo -> ConnectionInfo -> Bool #

newtype Namespace Source #

Constructors

Namespace Text

Instances

Instances details

Show Namespace Source #
Instance details Defined in Faktory.Connection Methods showsPrec :: Int -> Namespace -> ShowS # show :: Namespace -> String # showList :: [Namespace] -> ShowS #
Eq Namespace Source #
Instance details Defined in Faktory.Connection Methods (==) :: Namespace -> Namespace -> Bool # (/=) :: Namespace -> Namespace -> Bool #