Skip to main content

Module websocket

Module websocket 

Source
Expand description

WebSocket transport for the remote SDK (LP-WS-TRANSPORT R2/R3, client legs).

Layering, bottom to top:

  • core — the transport-neutral, no_std + alloc, event-driven liminal driver (R3.1). Closed socket events in, closed commands out; owns canonical-frame validation and in-flight wire correlation.
  • binding — the R2.2 conduit that passes socket facts into the landed client unit (liminal-protocol) as typed fates and returns aggregate-made decisions; no reconnect, retry, replay, or timer policy lives outside the aggregate.
  • The blocking std adapter, connection, and subscription stream (R2.1), which drive the same driver commands with synchronous tungstenite, matching the SDK’s synchronous model.
  • web_socket — the browser leg (R3.2): the platform-neutral F5 mirror layer plus the web-sys shim behind the browser feature on wasm32, binding the same driver to browser callbacks.

The transport carries the canonical liminal wire protocol: one encoded frame is exactly one binary WebSocket message, encoded and decoded by liminal::protocol — there is no WS-specific codec and no protocol translation.

Re-exports§

pub use binding::AttemptFateOutcome;
pub use binding::AttemptFateRefusal;
pub use binding::DetachLossOutcome;
pub use binding::LossRecordOutcome;
pub use binding::LossRecordRefusal;
pub use binding::OpenRequestDecision;
pub use binding::OpenRequestRefusal;
pub use binding::WebSocketAuthorityBinding;
pub use core::CommandRefusal;
pub use core::DriverOutput;
pub use core::DriverPhase;
pub use core::DriverStep;
pub use core::EventRefusal;
pub use core::FrameCorrelation;
pub use core::FrameViolation;
pub use core::PostTerminalEvent;
pub use core::ResponseExpectation;
pub use core::SocketCommand;
pub use core::SocketEvent;
pub use core::SocketFailure;
pub use core::TransportTerminal;
pub use core::WebSocketFrameDriver;

Modules§

binding
R2.2 typed-fate wiring: socket facts enter the client unit; policy never exits it.
core
Transport-neutral, event-driven WebSocket liminal driver (R3.1).
web_socket
Browser (wasm) WebSocket adapter for the transport-neutral driver (LP-WS-TRANSPORT R3.2, folded F4/F5).

Structs§

WebSocketDeliveredMessage
A message the server delivered on this WebSocket subscription.
WebSocketRemoteTransport
Real WebSocket transport that exchanges canonical wire frames with a liminal server over the sibling WebSocket acceptor.
WebSocketSubscriptionStream
A connected WebSocket subscription whose background reader surfaces delivered messages.

Functions§

liminal_ws_message_bound
The F2 reassembly bound: the active liminal frame bound, derived from the protocol’s named product limit FRAME_MAX (ten-byte header plus the generic u32 payload ceiling).