Data.Poolboy · poolboy-0.5.0.1

Configuration

8 declarations

datadata PoolboySettings (m :: Type -> Type)

#

Initial settings

Constructors

PoolboySettings
- workersCount :: WorkersCountSettings
- workQueueName :: String
- logger :: PoolboyCommand -> m ()

datadata WorkersCountSettings

#

Initial number of threads

Constructors

CapabilitiesWCS
getNumCapabilities based number
FixedWCS Int

Instances2Eq, Show

Eq WorkersCountSettingsDefined in poolboy-0.5.0.1 · Data.Poolboy
Show WorkersCountSettingsDefined in poolboy-0.5.0.1 · Data.Poolboy

datadata PoolboyCommand

#

Commands performed on the queue

Instances2Eq, Show

Eq PoolboyCommandDefined in poolboy-0.5.0.1 · Data.Poolboy
Show PoolboyCommandDefined in poolboy-0.5.0.1 · Data.Poolboy

valuedefaultPoolboySettings :: (HasCallStack, Monad m) => PoolboySettings m

#

Usual configuration CapabilitiesWCS and no name

valuepoolboySettingsWith :: (HasCallStack, Monad m) => Int -> PoolboySettings m

#

Arbitrary-numbered of workers settings

valuepoolboySettingsName :: String -> PoolboySettings m -> PoolboySettings m

#

Name of the work queue settings (used in error and debugging)

valuepoolboySettingsLog

:: Functor m
=> PoolboyCommand -> m a
-> PoolboySettings m
-> PoolboySettings m

#

Name of the work queue settings (used in error and debugging)

valuehoistPoolboySettings

:: forall a. m a -> n a
-> PoolboySettings m
-> PoolboySettings n

#

Change PoolboySettings monad

Running

4 declarations

datadata WorkQueue (m :: Type -> Type)

#

valuewithPoolboy

:: MonadUnliftIO m
=> PoolboySettings m
-> WaitingStopStrategy m
-> WorkQueue m -> m a
-> m a

#

backet-based usage (recommended)

valuenewPoolboy :: MonadIO m => PoolboySettings m -> m (WorkQueue m)

#

Standalone/manual usage

valuehoistWorkQueue :: (forall a. m a -> n a) -> WorkQueue m -> WorkQueue n

#

Change WorkQueue monad

Driving

2 declarations

valuechangeDesiredWorkersCount :: MonadUnliftIO m => WorkQueue m -> Int -> m ()

#

Request a worker number adjustment

Warning: non-concurrent operation

valuewaitReadyQueue :: MonadUnliftIO m => WorkQueue m -> m ()

#

Block until one worker is available

Stopping

5 declarations

valuestopWorkQueue :: MonadIO m => WorkQueue m -> m ()

#

Request stopping wokers

valueisStoppedWorkQueue :: MonadIO m => WorkQueue m -> m Bool

#

Non-blocking check of the work queue's running status

typetype WaitingStopStrategy (m :: Type -> Type) = WorkQueue m -> m ()

#

valuewaitingStopTimeout :: MonadUnliftIO m => Int -> WaitingStopStrategy m

#

Block until the queue is totally stopped or deadline (in micro seconds) is reached

valuewaitingStopFinishWorkers :: MonadUnliftIO m => WaitingStopStrategy m

#

Block until the queue is totally stopped (no more running worker)

Enqueueing

5 declarations

valueenqueue :: MonadUnliftIO m => WorkQueue m -> m () -> m ()

#

Enqueue one action in the work queue (non-blocking)

Throws WorkQueueStoppedException if the work queue is stopped

valueenqueueTracking :: MonadUnliftIO m => WorkQueue m -> m a -> m (Async a)

#

Enqueue one action in the work queue (non-blocking)

Throws WorkQueueStoppedException if the work queue is stopped

valueenqueueAfter

:: (Traversable f, MonadUnliftIO m)
=> WorkQueue m
-> m ()
-> f (m ())
-> m ()

#

Enqueue action and some actions to be run after it

Throws WorkQueueStoppedException if the work queue is stopped

valueenqueueAfterTracking

:: (Traversable f, MonadUnliftIO m)
=> WorkQueue m
-> m a
-> f (m b)
-> m (Async a, f (Async b))

#

Enqueue action and some actions to be run after it

Throws WorkQueueStoppedException if the work queue is stopped

newtypenewtype WorkQueueStoppedException

#

Instances3Eq, Show, Exception

Eq WorkQueueStoppedExceptionDefined in poolboy-0.5.0.1 · Data.Poolboy
Show WorkQueueStoppedExceptionDefined in poolboy-0.5.0.1 · Data.Poolboy
Exception WorkQueueStoppedExceptionDefined in poolboy-0.5.0.1 · Data.Poolboy