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

Control.Concurrent.RCU.Class

Description

Synopsis

class Monad m => MonadNew s m | m -> s where
class MonadNew s m => MonadReading s m | m -> s where
class MonadReading s m => MonadWriting s m | m -> s where
class (MonadReading s (Reading m), MonadWriting s (Writing m), MonadNew s m) => MonadRCU s m | m -> s where
- type Reading m :: * -> *
- type Writing m :: * -> *
- type Thread m :: * -> *
copySRef :: MonadReading s m => s a -> m (s a)

Documentation

class Monad m => MonadNew s m | m -> s where #

Methods

newSRef :: a -> m (s a) #

Build a new shared reference

newSRef :: (m ~ t n, MonadTrans t, MonadNew s n) => a -> m (s a) #

Build a new shared reference

Instances

MonadNew s m => MonadNew s (MaybeT m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods newSRef :: a -> MaybeT m (s a) #
MonadNew s m => MonadNew s (IdentityT m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods newSRef :: a -> IdentityT m (s a) #
MonadNew s m => MonadNew s (ExceptT e m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods newSRef :: a -> ExceptT e m (s a) #
MonadNew s' m => MonadNew s' (StateT s m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods newSRef :: a -> StateT s m (s' a) #
MonadNew s' m => MonadNew s' (StateT s m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods newSRef :: a -> StateT s m (s' a) #
(MonadNew s m, Monoid w) => MonadNew s (WriterT w m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods newSRef :: a -> WriterT w m (s a) #
(MonadNew s m, Monoid w) => MonadNew s (WriterT w m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods newSRef :: a -> WriterT w m (s a) #
MonadNew s m => MonadNew s (ReaderT e m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods newSRef :: a -> ReaderT e m (s a) #
(MonadNew s' m, Monoid w) => MonadNew s' (RWST r w s m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods newSRef :: a -> RWST r w s m (s' a) #
(MonadNew s' m, Monoid w) => MonadNew s' (RWST r w s m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods newSRef :: a -> RWST r w s m (s' a) #
MonadNew (SRef s) (RCU s) #
Instance details Defined in Control.Concurrent.RCU.GC.Internal Methods newSRef :: a -> RCU s (SRef s a) #
MonadNew (SRef s) (WritingRCU s) #
Instance details Defined in Control.Concurrent.RCU.GC.Internal Methods newSRef :: a -> WritingRCU s (SRef s a) #
MonadNew (SRef s) (ReadingRCU s) #
Instance details Defined in Control.Concurrent.RCU.GC.Internal Methods newSRef :: a -> ReadingRCU s (SRef s a) #
MonadNew (SRef s) (RCU s) #
Instance details Defined in Control.Concurrent.RCU.QSBR.Internal Methods newSRef :: a -> RCU s (SRef s a) #
MonadNew (SRef s) (WritingRCU s) #
Instance details Defined in Control.Concurrent.RCU.QSBR.Internal Methods newSRef :: a -> WritingRCU s (SRef s a) #
MonadNew (SRef s) (ReadingRCU s) #
Instance details Defined in Control.Concurrent.RCU.QSBR.Internal Methods newSRef :: a -> ReadingRCU s (SRef s a) #

class MonadNew s m => MonadReading s m | m -> s where #

This is a read-side critical section

Methods

readSRef :: s a -> m a #

Read a shared reference.

readSRef :: (m ~ t n, MonadTrans t, MonadReading s n) => s a -> m a #

Read a shared reference.

Instances

MonadReading s m => MonadReading s (MaybeT m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods readSRef :: s a -> MaybeT m a #
MonadReading s m => MonadReading s (IdentityT m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods readSRef :: s a -> IdentityT m a #
MonadReading s m => MonadReading s (ExceptT e m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods readSRef :: s a -> ExceptT e m a #
MonadReading s' m => MonadReading s' (StateT s m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods readSRef :: s' a -> StateT s m a #
MonadReading s' m => MonadReading s' (StateT s m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods readSRef :: s' a -> StateT s m a #
(MonadReading s m, Monoid w) => MonadReading s (WriterT w m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods readSRef :: s a -> WriterT w m a #
(MonadReading s m, Monoid w) => MonadReading s (WriterT w m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods readSRef :: s a -> WriterT w m a #
MonadReading s m => MonadReading s (ReaderT e m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods readSRef :: s a -> ReaderT e m a #
(MonadReading s' m, Monoid w) => MonadReading s' (RWST r w s m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods readSRef :: s' a -> RWST r w s m a #
(MonadReading s' m, Monoid w) => MonadReading s' (RWST r w s m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods readSRef :: s' a -> RWST r w s m a #
MonadReading (SRef s) (WritingRCU s) #
Instance details Defined in Control.Concurrent.RCU.GC.Internal Methods readSRef :: SRef s a -> WritingRCU s a #
MonadReading (SRef s) (ReadingRCU s) #
Instance details Defined in Control.Concurrent.RCU.GC.Internal Methods readSRef :: SRef s a -> ReadingRCU s a #
MonadReading (SRef s) (WritingRCU s) #
Instance details Defined in Control.Concurrent.RCU.QSBR.Internal Methods readSRef :: SRef s a -> WritingRCU s a #
MonadReading (SRef s) (ReadingRCU s) #
Instance details Defined in Control.Concurrent.RCU.QSBR.Internal Methods readSRef :: SRef s a -> ReadingRCU s a #

class MonadReading s m => MonadWriting s m | m -> s where #

This is a write-side critical section

Methods

writeSRef :: s a -> a -> m () #

Write to a shared reference.

writeSRef :: (m ~ t n, MonadTrans t, MonadWriting s n) => s a -> a -> m () #

Write to a shared reference.

synchronize :: m () #

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!

synchronize :: (m ~ t n, MonadTrans t, MonadWriting s n) => m () #

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!

Instances

MonadWriting s m => MonadWriting s (MaybeT m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods writeSRef :: s a -> a -> MaybeT m () # synchronize :: MaybeT m () #
MonadWriting s m => MonadWriting s (ExceptT e m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods writeSRef :: s a -> a -> ExceptT e m () # synchronize :: ExceptT e m () #
MonadWriting s m => MonadWriting s (IdentityT m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods writeSRef :: s a -> a -> IdentityT m () # synchronize :: IdentityT m () #
MonadWriting s' m => MonadWriting s' (StateT s m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods writeSRef :: s' a -> a -> StateT s m () # synchronize :: StateT s m () #
MonadWriting s' m => MonadWriting s' (StateT s m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods writeSRef :: s' a -> a -> StateT s m () # synchronize :: StateT s m () #
(MonadWriting s m, Monoid w) => MonadWriting s (WriterT w m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods writeSRef :: s a -> a -> WriterT w m () # synchronize :: WriterT w m () #
(MonadWriting s m, Monoid w) => MonadWriting s (WriterT w m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods writeSRef :: s a -> a -> WriterT w m () # synchronize :: WriterT w m () #
MonadWriting s m => MonadWriting s (ReaderT e m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods writeSRef :: s a -> a -> ReaderT e m () # synchronize :: ReaderT e m () #
(MonadWriting s' m, Monoid w) => MonadWriting s' (RWST r w s m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods writeSRef :: s' a -> a -> RWST r w s m () # synchronize :: RWST r w s m () #
(MonadWriting s' m, Monoid w) => MonadWriting s' (RWST r w s m) #
Instance details Defined in Control.Concurrent.RCU.Class Methods writeSRef :: s' a -> a -> RWST r w s m () # synchronize :: RWST r w s m () #
MonadWriting (SRef s) (WritingRCU s) #
Instance details Defined in Control.Concurrent.RCU.GC.Internal Methods writeSRef :: SRef s a -> a -> WritingRCU s () # synchronize :: WritingRCU s () #
MonadWriting (SRef s) (WritingRCU s) #
Instance details Defined in Control.Concurrent.RCU.QSBR.Internal Methods writeSRef :: SRef s a -> a -> WritingRCU s () # synchronize :: WritingRCU s () #

class (MonadReading s (Reading m), MonadWriting s (Writing m), MonadNew s m) => MonadRCU s m | m -> s where #

This is the executor service that can fork, join and execute critical sections.

Minimal complete definition

forking, joining, reading, writing

Associated Types

type Reading m :: * -> * #

A read-side critical section

type Writing m :: * -> * #

A write-side critical section

type Thread m :: * -> * #

Threads we can fork and join

Methods

forking :: m a -> m (Thread m a) #

Fork a thread

joining :: Thread m a -> m a #

Join a thread

reading :: Reading m a -> m a #

Run a read-side critical section

writing :: Writing m a -> m a #

Run a write-side critical section

Instances

MonadRCU s m => MonadRCU s (MaybeT m) #
Instance details Defined in Control.Concurrent.RCU.Class Associated Types type Reading (MaybeT m) :: * -> * # type Writing (MaybeT m) :: * -> * # type Thread (MaybeT m) :: * -> * # Methods forking :: MaybeT m a -> MaybeT m (Thread (MaybeT m) a) # joining :: Thread (MaybeT m) a -> MaybeT m a # reading :: Reading (MaybeT m) a -> MaybeT m a # writing :: Writing (MaybeT m) a -> MaybeT m a #
(MonadRCU s m, Monoid e) => MonadRCU s (WriterT e m) #
Instance details Defined in Control.Concurrent.RCU.Class Associated Types type Reading (WriterT e m) :: * -> * # type Writing (WriterT e m) :: * -> * # type Thread (WriterT e m) :: * -> * # Methods forking :: WriterT e m a -> WriterT e m (Thread (WriterT e m) a) # joining :: Thread (WriterT e m) a -> WriterT e m a # reading :: Reading (WriterT e m) a -> WriterT e m a # writing :: Writing (WriterT e m) a -> WriterT e m a #
(MonadRCU s m, Monoid e) => MonadRCU s (WriterT e m) #
Instance details Defined in Control.Concurrent.RCU.Class Associated Types type Reading (WriterT e m) :: * -> * # type Writing (WriterT e m) :: * -> * # type Thread (WriterT e m) :: * -> * # Methods forking :: WriterT e m a -> WriterT e m (Thread (WriterT e m) a) # joining :: Thread (WriterT e m) a -> WriterT e m a # reading :: Reading (WriterT e m) a -> WriterT e m a # writing :: Writing (WriterT e m) a -> WriterT e m a #
MonadRCU s m => MonadRCU s (ExceptT e m) #
Instance details Defined in Control.Concurrent.RCU.Class Associated Types type Reading (ExceptT e m) :: * -> * # type Writing (ExceptT e m) :: * -> * # type Thread (ExceptT e m) :: * -> * # Methods forking :: ExceptT e m a -> ExceptT e m (Thread (ExceptT e m) a) # joining :: Thread (ExceptT e m) a -> ExceptT e m a # reading :: Reading (ExceptT e m) a -> ExceptT e m a # writing :: Writing (ExceptT e m) a -> ExceptT e m a #
MonadRCU s m => MonadRCU s (IdentityT m) #
Instance details Defined in Control.Concurrent.RCU.Class Associated Types type Reading (IdentityT m) :: * -> * # type Writing (IdentityT m) :: * -> * # type Thread (IdentityT m) :: * -> * # Methods forking :: IdentityT m a -> IdentityT m (Thread (IdentityT m) a) # joining :: Thread (IdentityT m) a -> IdentityT m a # reading :: Reading (IdentityT m) a -> IdentityT m a # writing :: Writing (IdentityT m) a -> IdentityT m a #
MonadRCU s m => MonadRCU s (ReaderT e m) #
Instance details Defined in Control.Concurrent.RCU.Class Associated Types type Reading (ReaderT e m) :: * -> * # type Writing (ReaderT e m) :: * -> * # type Thread (ReaderT e m) :: * -> * # Methods forking :: ReaderT e m a -> ReaderT e m (Thread (ReaderT e m) a) # joining :: Thread (ReaderT e m) a -> ReaderT e m a # reading :: Reading (ReaderT e m) a -> ReaderT e m a # writing :: Writing (ReaderT e m) a -> ReaderT e m a #
MonadRCU (SRef s) (RCU s) #
Instance details Defined in Control.Concurrent.RCU.GC.Internal Associated Types type Reading (RCU s) :: * -> * # type Writing (RCU s) :: * -> * # type Thread (RCU s) :: * -> * # Methods forking :: RCU s a -> RCU s (Thread (RCU s) a) # joining :: Thread (RCU s) a -> RCU s a # reading :: Reading (RCU s) a -> RCU s a # writing :: Writing (RCU s) a -> RCU s a #
MonadRCU (SRef s) (RCU s) #
Instance details Defined in Control.Concurrent.RCU.QSBR.Internal Associated Types type Reading (RCU s) :: * -> * # type Writing (RCU s) :: * -> * # type Thread (RCU s) :: * -> * # Methods forking :: RCU s a -> RCU s (Thread (RCU s) a) # joining :: Thread (RCU s) a -> RCU s a # reading :: Reading (RCU s) a -> RCU s a # writing :: Writing (RCU s) a -> RCU s a #

copySRef :: MonadReading s m => s a -> m (s a) #

Copy a shared reference.