Data.NonBlocking.LockFree.Treiber

An implementation of Treiber stacks, a lock free stack. Works with any monad that has atomically modificable references.

Documentation

data TreiberStack r a

A Lock-free concurrent Treiber stack usable in any monad, m, that is paired with a reference type, r, by an instance of MonadAtomicRef. Can use Specializations TreiberStackIO and TreiberStackSTM

type TreiberStackIO a = TreiberStack IORef a

TreiberStack inside the IO Monad.

type TreiberStackSTM a = TreiberStack TVar a

TreiberStack inside the STM Monad.

newTreiberStack :: (MonadAtomicRef r m, Eq a) => m (TreiberStack r a)

Creates a new empty instance of the TreiberStack. Internally implemented with a reference of type r, which is why they must be atomically modifiable.

pushTreiberStack :: (MonadAtomicRef r m, Eq a) => TreiberStack r a -> a -> m ()

Pushes an element on to a Treiber stack.

popTreiberStack :: (MonadAtomicRef r m, Eq a) => TreiberStack r a -> m (Maybe a)

Pops an element of a Treiber stack. Returns Nothing if the stack is empty.