Modulevortex-combinators-0.1.1.0GHC2024

Vortex.Combinators.Transport

How a forwarder reaches its upstream: one Call out, one terminal Reply back. Two interpretations: the vortex wire, a Session whose frames are the show of calls and replies, and an in-memory loopback that passes the same text to a local answerer. The serving side is a vortex-call Table built from the theory's Wire.

2 types
7 values

Packagevortex-combinators-0.1.1.0
Exports9
LanguageGHC2024
LicenceMIT
SourceTransport.hs

The effect

2 declarations

datadata Transport (m :: Type -> Type) a where

Send one call and wait for its terminal reply. A Left is the transport's own failure: no reply came, or what came did not read.

Exchange :: Call -> Transport m (Either Failure Reply)exchange

valueexchange :: Member Transport r => Call -> Sem r (Either Failure Reply)

from Exchange

Loopback

2 declarations

valuerunTransportLoopback

:: Call -> Sem r Reply
-> Sem (Transport ': r) a
-> Sem r a

A transport whose far end is a local answerer. The call and the reply each pass through their show and read, as on the wire.

valueanswerCall

:: Wire e
=> Handler e (Error Failure ': r)
-> Call
-> Sem r Reply

The far end of a loopback: decode the call, run it, and reply as a served table does, with a failure as the show of the Failure.

The vortex wire

5 declarations

valuerunTransportSession

:: Member (Embed IO) r
=> Session
-> Sem (Transport ': r) a
-> Sem r a

A transport over a vortex session: each call is a frame, and the reply is the first terminal frame back. Said frames on the way are passed over.

valuetheoryTable :: Wire e => Proxy e -> Handler e r -> Table (Sem r)

Every verb of a theory as a vortex-call table entry, metered, run by the handler.

valueserveTheory

:: Wire e
=> Proxy e
-> forall x. Sem r x -> IO (Either Failure x)
-> Handler e r
-> Wisp
-> Session
-> IO ()

Serve a theory over a session with vortex-call's serveTable. The lowering runs a handler's row in IO; a failure it returns becomes a WireFailure, which vortex-run reports as the Failed frame a forwarder reads back as the same Failure.

newtypenewtype WireFailure

A failure in flight from a served handler to vortex-run.

Constructors

WireFailure Failure

Instances2Show, Exception

Show WireFailureDefined in vortex-combinators-0.1.1.0 · Vortex.Combinators.Transport
vortex-run renders a thrown exception with show into its Failed frame, so this shows exactly the Failure for the forwarder to read.
Exception WireFailureDefined in vortex-combinators-0.1.1.0 · Vortex.Combinators.Transport

valuereadFailure :: String -> Failure

A Failed frame's failure: a served Failure reads back as itself, and anything else (a refused call, fuel run out) is the far end's refusal.