Modulevortex-session-0.3.0GHC2024

Vortex.Session

The seam between transports and everything else. A transport's whole job is to produce values of Session; it knows nothing about wisps, shells, or evaluation. Process isolation, if ever wanted, is a Session backed by a socket handoff — no other layer changes.

3 types

Packagevortex-session-0.3.0
Exports3
LanguageGHC2024
LicenceBSD-3-Clause
SourceSession.hs

datadata Identity

Raw authentication material, pre-login. Login turns this into a Wisp; transports never do.

Constructors

Anonymous
An unauthenticated transport (e.g. a websocket on a trusted network); login policy decides what becomes of it.
RawKey String
A raw public key, textual form.
Principals [String]
A CA certificate's principals, as verified by the transport.
Peer Int Int Int
A unix-socket peer, as the kernel reports it: uid, gid, pid.

Instances2Eq, Show

Eq IdentityDefined in vortex-session-0.3.0 · Vortex.Session
Show IdentityDefined in vortex-session-0.3.0 · Vortex.Session

datadata Request

Constructors

Exec String
Evaluate one block and end the session.
InteractiveShell
An interactive session.
Subsystem String
A named service; block streaming uses Subsystem "vortex".

Instances2Eq, Show

Eq RequestDefined in vortex-session-0.3.0 · Vortex.Session
Show RequestDefined in vortex-session-0.3.0 · Vortex.Session

datadata Session

Constructors

Session
- peer :: Identity
- request :: Request
- recvFrame :: IO (Maybe String)
  Next text frame from the peer; Nothing when the stream ends.
- sendFrame :: String -> IO ()
  Send a text frame.
- recvBytes :: IO (Maybe ByteString)
  Next binary frame from the peer; Nothing when the stream ends. Used by a duplex call (a streaming verb like git) once it is under way; the text frames carry the control Replys and the binary frames the chunks.
- sendBytes :: ByteString -> IO ()
  Send a binary frame.