PrioritySync.Internal.TaskPool

A prioritized TaskPool. This consists of a Queue, which prioritizes tasks, and a Room which restricts the number of tasks that may execute at one time.

Documentation

data TaskPool p u

Instances

RoomGroup (TaskPool p u)

Ord p => Occupancy (TaskPool p u)

schedule :: TaskPool p u -> p -> Schedule p (Constrained (TaskPoolConstraint u), Room (TaskPoolConstraint u))

A prioritized ClaimContext for a task pool.

newTaskPool :: Ord p => QueueConfigurationRecord p -> Int -> u -> IO (TaskPool p u)

Create a new TaskPool. TaskPools begin stopped, use startQueue to start.

• A QueueConfigurationRecord for the backing Queue. A typical value is fair_queue_configuration.
• The allowed number of threads that can access the TaskPool simultaneously.
• The user data for the backing Room. This can be ().

Consider using simpleTaskPool if you have no special needs.

simpleTaskPool :: Ord p => IO (TaskPool p ())

Just create a new TaskPool. The task pool is constrained by the number of capabilities indicated by numCapabilities.

poolRoom :: TaskPool p u -> Room (TaskPoolConstraint u)

Get the Room that primarily constrains this TaskPool.

poolQueue :: TaskPool p u -> Queue p

Get the Queue that admits new tasks to this TaskPool.

startQueue :: TaskPool p u -> STM ()

Start the TaskPool.

stopQueue :: TaskPool p u -> STM ()

Stop all activity on this TaskPool.

isEmpty :: Ord p => TaskPool p u -> STM Bool

True iff this TaskPool is entirely empty and inactive.

waitUntilFinished :: Ord p => TaskPool p u -> IO ()

Wait until a queue is finished.