Contents

Server <REQ, RES, M, A>

Value
Server (Proxy<Void, Unit, REQ, RES, M, A> value)
ToProxy ()
Bind (Func<A, Proxy<Void, Unit, REQ, RES, M, B>> f)
Map (Func<A, B> f)
MapM (Func<K<M, A>, K<M, B>> f)
ToIO ()
Bind (Func<A, Server<REQ, RES, M, B>> f)
SelectMany (Func<A, Server<REQ, RES, M, B>> f)
SelectMany <B, C> (Func<A, Server<REQ, RES, M, B>> f, Func<A, B, C> project)
Select (Func<A, B> f)
For <C1, C> (Func<RES, Proxy<Void, Unit, C1, C, M, REQ>> body)
Action <S> (Proxy<Void, Unit, REQ, RES, M, S> r)
PairEachRequestWithRespond <UOutA, AUInA> ( Func<Void, Proxy<UOutA, AUInA, Void, Unit, M, A>> lhs)
ReplaceRequest <UOutA, AUInA> ( Func<Void, Proxy<UOutA, AUInA, REQ, RES, M, Unit>> lhs)
PairEachRespondWithRequest <DInC, DOutC> ( Func<RES, Proxy<REQ, RES, DInC, DOutC, M, A>> rhs)
ReplaceRespond <DInC, DOutC> ( Func<RES, Proxy<Void, Unit, DInC, DOutC, M, REQ>> rhs)
Reflect ()
Observe ()
Deconstruct (out Proxy<Void, Unit, REQ, RES, M, A> value)
& ( Server<REQ, RES, M, A> lhs, Server<REQ, RES, M, A> rhs)

Server

Pure <REQ, RES, M, R> (R value)
respond <REQ, RES, M> (RES value)
lift <REQ, RES, M, R> (K<M, R> ma)
liftIO <REQ, RES, M, R> (IO<R> ma)

record Server <REQ, RES, M, A> Source #

where M : Monad<M>

Server receives requests of type REQ and sends responses of type RES.

Servers only respond and never request.

  Upstream | Downstream
      +---------+
      |         |
Void <==       <== RES
      |         |
Unit ==>       ==> REQ
      |    |    |
      +----|----+
           |
           A

Fields

field Proxy<Void, Unit, REQ, RES, M, A> Value Source #

Constructors

constructor Server (Proxy<Void, Unit, REQ, RES, M, A> value) Source #

Constructor

Parameters

param

value

Correctly shaped Proxy that represents a Server

Methods

method Proxy<Void, Unit, REQ, RES, M, A> ToProxy () Source #

Calling this will effectively cast the subtype to the base.

This type wraps up a Proxy for convenience, and so it's a Proxy proxy. So calling this method isn't exactly the same as a cast operation, as it unwraps the Proxy from within. It has the same effect however, and removes a level of indirection

Parameters

returns

A general Proxy type from a more specialised type

method Proxy<Void, Unit, REQ, RES, M, B> Bind (Func<A, Proxy<Void, Unit, REQ, RES, M, B>> f) Source #

Monadic bind operation, for chaining Proxy computations together.

Parameters

type	B	The mapped bound value type
param	f	The bind function
returns	A new `Proxy` that represents the composition of this `Proxy` and the result of the bind operation

method Proxy<Void, Unit, REQ, RES, M, B> Map (Func<A, B> f) Source #

Lifts a pure function into the Proxy domain, causing it to map the bound value within

Parameters

type	B	The mapped bound value type
param	f	The map function
returns	A new `Proxy` that represents the composition of this `Proxy` and the result of the map operation

method Proxy<Void, Unit, REQ, RES, M, B> MapM (Func<K<M, A>, K<M, B>> f) Source #

Map the lifted monad

Parameters

type	B	The mapped bound value type
param	f	The map function
returns	A new `Proxy` that represents the composition of this `Proxy` and the result of the map operation

method Proxy<Void, Unit, REQ, RES, M, IO<A>> ToIO () Source #

Extract the lifted IO monad (if there is one)

Parameters

param	f	The map function
returns	A new `Proxy` that represents the innermost IO monad, if it exists.

method Server<REQ, RES, M, B> Bind (Func<A, Server<REQ, RES, M, B>> f) Source #

Monadic bind operation, for chaining Server computations together.

Parameters

type	B	The mapped bound value type
param	f	The bind function
returns	A new `Proxy` that represents the composition of this `Proxy` and the result of the bind operation

method Server<REQ, RES, M, B> SelectMany (Func<A, Server<REQ, RES, M, B>> f) Source #

Monadic bind operation, for chaining Server computations together.

Parameters

type	B	The mapped bound value type
param	f	The bind function
returns	A new `Proxy` that represents the composition of this `Proxy` and the result of the bind operation

method Server<REQ, RES, M, C> SelectMany <B, C> (Func<A, Server<REQ, RES, M, B>> f, Func<A, B, C> project) Source #

Monadic bind operation, for chaining Server computations together.

Parameters

type	B	The mapped bound value type
param	f	The bind function
returns	A new `Proxy` that represents the composition of this `Proxy` and the result of the bind operation

method Server<REQ, RES, M, B> Select (Func<A, B> f) Source #

Lifts a pure function into the Proxy domain, causing it to map the bound value within

Parameters

type	B	The mapped bound value type
param	f	The map function
returns	A new `Proxy` that represents the composition of this `Proxy` and the result of the map operation

method Proxy<Void, Unit, C1, C, M, A> For <C1, C> (Func<RES, Proxy<Void, Unit, C1, C, M, REQ>> body) Source #

For(body) loops over the Proxy p replacing each yield with body

Parameters

param	body	Any `yield` found in the `Proxy` will be replaced with this function. It will be composed so that the value yielded will be passed to the argument of the function. That returns a `Proxy` to continue the processing of the computation
returns	A new `Proxy` that represents the composition of this `Proxy` and the function provided

method Proxy<Void, Unit, REQ, RES, M, S> Action <S> (Proxy<Void, Unit, REQ, RES, M, S> r) Source #

Applicative action

Invokes this Proxy, then the Proxy r

Parameters

param

r

Proxy to run after this one

method Proxy<UOutA, AUInA, REQ, RES, M, A> PairEachRequestWithRespond <UOutA, AUInA> ( Func<Void, Proxy<UOutA, AUInA, Void, Unit, M, A>> lhs) Source #

Used by the various composition functions and when composing proxies with the | operator. You usually wouldn't need to call this directly, instead either pipe them using | or call Proxy.compose(lhs, rhs)

(f +>> p) pairs each 'request' in this with a 'respond' in lhs.

method Proxy<UOutA, AUInA, REQ, RES, M, A> ReplaceRequest <UOutA, AUInA> ( Func<Void, Proxy<UOutA, AUInA, REQ, RES, M, Unit>> lhs) Source #

Used by the various composition functions and when composing proxies with the | operator. You usually wouldn't need to call this directly, instead either pipe them using | or call Proxy.compose(lhs, rhs)

method Proxy<Void, Unit, DInC, DOutC, M, A> PairEachRespondWithRequest <DInC, DOutC> ( Func<RES, Proxy<REQ, RES, DInC, DOutC, M, A>> rhs) Source #

Used by the various composition functions and when composing proxies with the | operator. You usually wouldn't need to call this directly, instead either pipe them using | or call Proxy.compose(lhs, rhs)

method Proxy<Void, Unit, DInC, DOutC, M, A> ReplaceRespond <DInC, DOutC> ( Func<RES, Proxy<Void, Unit, DInC, DOutC, M, REQ>> rhs) Source #

Used by the various composition functions and when composing proxies with the | operator. You usually wouldn't need to call this directly, instead either pipe them using | or call Proxy.compose(lhs, rhs)

method Proxy<RES, REQ, Unit, Void, M, A> Reflect () Source #

Reverse the arrows of the Proxy to find its dual.

Parameters

returns

The dual of this

method Proxy<Void, Unit, REQ, RES, M, A> Observe () Source #

Observe(lift (Pure(r))) = Observe(Pure(r))
Observe(lift (m.Bind(f))) = Observe(lift(m.Bind(x => lift(f(x)))))

This correctness comes at a small cost to performance, so use this function sparingly. This function is a convenience for low-level pipes implementers. You do not need to use observe if you stick to the safe API.

method void Deconstruct (out Proxy<Void, Unit, REQ, RES, M, A> value) Source #

Operators

operator & ( Server<REQ, RES, M, A> lhs, Server<REQ, RES, M, A> rhs) Source #

Chain one server after another

class Server Source #

Server receives requests of type REQ and sends responses of type RES.

Servers only respond and never request.

  Upstream | Downstream
      +---------+
      |         |
Void <==       <== RES
      |         |
Unit ==>       ==> REQ
      |    |    |
      +----|----+
           |
           A

Methods

method Server<REQ, RES, M, R> Pure <REQ, RES, M, R> (R value) Source #

where M : Monad<M>

Monad return / pure

method Server<REQ, RES, M, REQ> respond <REQ, RES, M> (RES value) Source #

where M : Monad<M>

Send a value of type RES downstream and block waiting for a reply of type REQ

respond is the identity of the respond category.

method Server<REQ, RES, M, R> lift <REQ, RES, M, R> (K<M, R> ma) Source #

where M : Monad<M>

Lift am IO monad into the Proxy monad transformer

method Server<REQ, RES, M, R> liftIO <REQ, RES, M, R> (IO<R> ma) Source #

where M : Monad<M>

Lift am IO monad into the Proxy monad transformer