muxwsMultiplexed streams over one WebSocket

Either end can open a stream. Each stream can be cancelled independently. Large payloads are fragmented, so they do not delay small ones. muxws provides the multiplexing layer that applications otherwise implement themselves.

Get Started

API Reference

GitHub

HTTP/2 and HTTP/3 semantics, on a WebSocket

The stream model of HTTP/2 and HTTP/3 - many independent streams, either end can open one, per-stream cancellation - without a QUIC or HTTP/3 stack.

Symmetric peers

One Peer type per language. Server push is the same mechanism as a client request.

Automatic fragmentation

Payloads above the 64 KiB frame cap are split and reassembled automatically, and a round-robin writer interleaves the fragments of concurrent streams.

Reconnect with hello replay

Jittered backoff, a heartbeat that bounds the time to detect a dead connection, and an opening payload replayed on every connection.

Pluggable codec

JSON by default, msgpack optional, custom codecs supported. The codec is part of the subprotocol and is checked at the handshake.

Independent implementations

Python and TypeScript, each a complete implementation of the same frozen wire protocol. A normative specification and a shared conformance corpus define the protocol, so a further implementation does not depend on either existing implementation's source.