Control.Concurrent.Bag.Concurrent

This is a low-level interface to the bag of tasks. This implementation does not use stm in contrast to the other implementation. This implementation is provided for performance comparision. This implementation should only be used if it is not possible to use Control.Concurrent.Bag.SafeConcurrent for your task. This module allows more control but it also requires a deeper knowledge about the implementation.

Documentation

data Bag r

The bag of tasks type.

newBag

Arguments

:: MonadIO m

=> BufferType

type of the used buffer(s)

-> Int

Number of threads

-> m (Bag r)

Build and return a new bag of tasks.

newBag_

Arguments

:: MonadIO m

=> BufferType

type of the used buffer(s)

-> m (Bag r)

Create a new bag and use the number of capabilities as the thread count.

addEval :: MonadIO m => Bag r -> r -> m ()

Add the evaluation of a haskell expression.

The given expression will be evaluated to weak head normal form.

addTask :: MonadIO m => Bag r -> IO (Maybe r) -> m ()

Add a task to the given bag of tasks.

getResult :: MonadIO m => Bag r -> m (Maybe r)

Get the next result written by writeResult.

writeResult :: MonadIO m => Bag r -> r -> m ()

Write back a result to be read by getResult.

terminateBag :: MonadIO m => Bag r -> m ()

Terminates all threads running in the thread pool. terminateBag is non-blocking and therefore does not guarantee that all threads are terminated after its executions. Additionally it is not guaranteed that the treads are terminated promptly. It is implemented using asynchronous exceptions and therefore it terminates a thread once it uses a safe point. A safe point is where memory allocation occurs. Although most tasks will have some point of memory allocation now and the, there are loops that will never reach a safe point.

noMoreTasks :: MonadIO m => Bag r -> m ()

Tell the bag that there will be no more tasks from the outside, however, queued tasks may still add new tasks.

module Control.Concurrent.Bag.TaskBuffer