Copyright | (C) 2015 Edward Kmett and Ted Cooper |
---|---|
License | BSD-style (see the file LICENSE) |
Maintainer | Edward Kmett <ekmett@gmail.com> Ted Cooper <anthezium@gmail.com> |
Stability | experimental |
Portability | non-portable |
Safe Haskell | Safe |
Language | Haskell2010 |
Synopsis
- class Monad m => MonadNew s m | m -> s where
- newSRef :: a -> m (s a)
- class MonadNew s m => MonadReading s m | m -> s where
- readSRef :: s a -> m a
- class MonadReading s m => MonadWriting s m | m -> s where
- writeSRef :: s a -> a -> m ()
- synchronize :: m ()
- class (MonadReading s (Reading m), MonadWriting s (Writing m), MonadNew s m) => MonadRCU s m | m -> s where
- copySRef :: MonadReading s m => s a -> m (s a)
Documentation
class Monad m => MonadNew s m | m -> s where Source #
Nothing
newSRef :: a -> m (s a) Source #
Build a new shared reference
default newSRef :: (m ~ t n, MonadTrans t, MonadNew s n) => a -> m (s a) Source #
Instances
class MonadNew s m => MonadReading s m | m -> s where Source #
This is a read-side critical section
Nothing
readSRef :: s a -> m a Source #
Read a shared reference.
default readSRef :: (m ~ t n, MonadTrans t, MonadReading s n) => s a -> m a Source #
Instances
class MonadReading s m => MonadWriting s m | m -> s where Source #
This is a write-side critical section
Nothing
writeSRef :: s a -> a -> m () Source #
Write to a shared reference.
default writeSRef :: (m ~ t n, MonadTrans t, MonadWriting s n) => s a -> a -> m () Source #
synchronize :: m () Source #
Synchronize with other writers.
No other writer can straddle this time bound. It will either see writes from before, or writes after, but never some of both!
default synchronize :: (m ~ t n, MonadTrans t, MonadWriting s n) => m () Source #
Instances
class (MonadReading s (Reading m), MonadWriting s (Writing m), MonadNew s m) => MonadRCU s m | m -> s where Source #
This is the executor service that can fork, join and execute critical sections.
type Reading m :: * -> * Source #
A read-side critical section
type Writing m :: * -> * Source #
A write-side critical section
type Thread m :: * -> * Source #
Threads we can fork and join
forking :: m a -> m (Thread m a) Source #
Fork a thread
joining :: Thread m a -> m a Source #
Join a thread
reading :: Reading m a -> m a Source #
Run a read-side critical section
writing :: Writing m a -> m a Source #
Run a write-side critical section
Instances
MonadRCU s m => MonadRCU s (MaybeT m) Source # | |
(MonadRCU s m, Monoid e) => MonadRCU s (WriterT e m) Source # | |
(MonadRCU s m, Monoid e) => MonadRCU s (WriterT e m) Source # | |
MonadRCU s m => MonadRCU s (ExceptT e m) Source # | |
MonadRCU s m => MonadRCU s (IdentityT m) Source # | |
MonadRCU s m => MonadRCU s (ReaderT e m) Source # | |
MonadRCU (SRef s) (RCU s) Source # | |
MonadRCU (SRef s) (RCU s) Source # | |
copySRef :: MonadReading s m => s a -> m (s a) Source #
Copy a shared reference.