Control.Concurrent.SCC.Foundation

Module Foundation defines the pipe computations and their basic building blocks.

Types

data Monad m => Pipe context m r

Pipe represents the type of monadic computations that can be split into co-routining computations using function pipe. The context type parameter delimits the scope of the computation.

Instances

Monad m => Monad (Pipe context m)

data Source context x

A Source is the read-only end of a Pipe communication channel.

data Sink context x

A Sink is the write-only end of a Pipe communication channel.

type Consumer m x r = forall c. Source c x -> Pipe c m r

A computation that consumes values from a Source is called Consumer.

type Producer m x r = forall c. Sink c x -> Pipe c m r

A computation that produces values and puts them into a Sink is called Producer.

Flow-control functions

pipe :: forall context x m r1 r2. Monad m => Producer m x r1 -> Consumer m x r2 -> Pipe context m (r1, r2)

The pipe function splits the computation into two concurrent parts, producer and consumer. The producer is given a Sink to put values into, and consumer a Source to get those values from. Once producer and consumer both complete, pipe returns their paired results.

pipeD :: forall context x m r1 r2. Monad m => String -> Producer m x r1 -> Consumer m x r2 -> Pipe context m (r1, r2)

The pipeD function is same as pipe, with an additional description argument.

get :: forall context context' x m r. (Monad m, Typeable x) => Source context' x -> Pipe context m (Maybe x)

Function get tries to get a value from the given Source argument. The intervening Pipe computations suspend all the way to the pipe function invocation that created the source. The result of get is Nothing iff the argument source is empty.

getSuccess

Arguments

:: forall context context' x m . (Monad m, Typeable x)

=> Source context' x

-> (x -> Pipe context m ())

Success continuation

-> Pipe context m ()

canPut :: forall context context' x m r. (Monad m, Typeable x) => Sink context' x -> Pipe context m Bool

Function canPut checks if the argument sink accepts values, i.e., whether a put operation would succeed on the sink.

put :: forall context context' x m r. (Monad m, Typeable x) => Sink context' x -> x -> Pipe context m Bool

Function put tries to put a value into the given sink. The intervening Pipe computations suspend up to the pipe invocation that has created the argument sink. The result of put indicates whether the operation succeded.

liftPipe :: forall context m r. Monad m => m r -> Pipe context m r

Function liftPipe lifts a value of the underlying monad type into a Pipe computation.

runPipes :: forall m r. Monad m => (forall context. Pipe context m r) -> m r

Function runPipes runs the given computation involving pipes and returns the final result. The context argument ensures that no suspended computation can escape its scope.

Utility functions

cond :: a -> a -> Bool -> a

A utility function wrapping if-then-else, useful for handling monadic truth values

whenNull :: forall a m. Monad m => m [a] -> [a] -> m [a]

A utility function, useful for handling monadic list values where empty list means success

pour :: forall c c1 c2 x m. (Monad m, Typeable x) => Source c1 x -> Sink c2 x -> Pipe c m ()

pour copies all data from the source argument into the sink argument, as long as there is anything to copy and the sink accepts it.

tee :: (Monad m, Typeable x) => Source c1 x -> Sink c2 x -> Sink c3 x -> Pipe c m ()

tee is similar to pour except it distributes every input value from the source arguments into both sink1 and sink2.

getList :: forall x c c1 m. (Monad m, Typeable x) => Source c1 x -> Pipe c m [x]

getList returns the list of all values generated by the source.

putList :: forall x c c1 m. (Monad m, Typeable x) => [x] -> Sink c1 x -> Pipe c m [x]

putList puts entire list into its sink argument, as long as the sink accepts it. The remainder that wasn't accepted by the sink is the result value.

consumeAndSuppress :: forall x c c1 m. (Monad m, Typeable x) => Source c1 x -> Pipe c m ()

consumeAndSuppress consumes the entire source ignoring the values it generates.