Module session

One WebSocket session: INIT, then PUB / SUB / UNSUB until close.

Binary frames are refused and the socket is closed. A parse error on a text frame is -ERR Illegal-Argument and the session stays up. A failed INIT closes it.

Structs

• LiveSub 🔒
  One client SUB: the engine key and the task that forwards MSG frames.
• RouteWarnings 🔒
  Unroutable publishes and invalid payloads, tracked separately.
• SeenRoutes 🔒
  Routes this connection has already been warned about.
• Session 🔒
  One accepted WebSocket and the engine handle it publishes through.
• ViolationWording 🔒
  The wording that differs between a violation found in what the producer put on the bus and one found in what xml_baseline conversion produced.

Enums

• Fatal 🔒
  End the WebSocket after an -ERR that the spec treats as fatal.
• Report 🔒
  Whether an unroutable publish is worth reporting yet.
• State 🔒
• Verdict 🔒
  What the caller of handle_violations should do with the delivery.

Constants

• OWP_VERSION 🔒
  Protocol version this server speaks. INIT must list it.

Functions

• cap_notice 🔒
  Say when a tracker has stopped naming routes, so a quiet log is not mistaken for a quiet client.
• deadline_elapsed 🔒
  Resolves once deadline passes, or never when it is None (the timeout disabled). Used as one arm of the session select!.
• err_op 🔒
  Builds a -ERR frame. details is the rest of the line when set.
• handle_init 🔒
  Negotiates INIT. Success sends INFO (and +OK when verbose).
• handle_pub 🔒
  Publishes onto the engine. A bad payload is -ERR Invalid-Message and the session stays up.
• handle_sub 🔒
  Subscribes the engine and spawns a forwarder that writes MSG frames.
• handle_text 🔒
  Dispatches one client text frame.
• handle_unsub 🔒
  Aborts the forwarder and unsubscribes. Unknown sid is -ERR.
• handle_violations 🔒
  Applies validate’s policy to violations: in Reject mode, sends a -ERR and reports Verdict::Drop; in Warn mode, only logs. Either way the warning is logged once per subscription, via logged.
• info_payload 🔒
  Builds INFO. The service UUID is v5 of the client’s service_id.
• negotiate 🔒
  Checks INIT.versions contains OWP_VERSION and INIT.schema matches when OwpConfig::schema is set.
• publish_owp 🔒
  Maps one PUB onto one or two engine envelopes and publishes them.
• run 🔒
  Runs session until shutdown, close, or a fatal protocol error.
• send 🔒
  Queues op for the writer. A full or closed channel is ignored so a slow client cannot stall the read loop.