Data.NonBlocking.LockFree.SpinCounter

An implementation of a lock-free spin counter. Works with any monad that has atomically modificable references.

Documentation

data SpinCounter r

A lock-free concurrent Spin counter usable in any monad, m, that is paired with a reference type, r, by an instance of MonadAtomicRef. Can use Specializations SpinCounterIO and SpinCounterSTM

type SpinCounterIO = SpinCounter IORef

SpinCounter inside the IO Monad.

type SpinCounterSTM = SpinCounter TVar

SpinCounter inside the STM Monad.

newSpinCounter :: (MonadAtomicRef r m, Integral a) => a -> m (SpinCounter r)

Creates a new instance of the SpinCounter data type initialized to value of the input to the function, an instance of the class Integral.

incSpinCounter :: MonadAtomicRef r m => SpinCounter r -> m ()

Increments an instance of the SpinCounter data type by one in a lock-free manner.

readSpinCounter :: (MonadAtomicRef r m, Num a) => SpinCounter r -> m a

Reads the value of an instance of the SpinCounter data type in a lock-free manner.