Class Endpoint

Create and setup a Mushi peer.

You must provide a local or unspecified address to bind the endpoint to. In most cases, [::]:0 suffices: this binds to all IP interfaces and selects a random port. Use localAddr() to discover the randomly-assigned port.

If bind_to resolves to multiple socket addresses, the first that succeeds creation of the socket will be used.

allower is the trust policy for remote peers: incoming (client certificate) and outgoing (server certificate) peers will have their public key extracted and checked by the Allower instance.

cc is the congestion control strategy for the QUIC state machine. One of cubic (RFC 8312), newreno (RFC 6582), or bbr (IETF Draft]. Defaults to cubic.

Accept an incoming session.

Using this is a bit un-JS-y. Conceptually, it's an async iterator which may throw at each call, and should be stopped once the function successfully returns null. A generator like this may be used to wrap the call more ergonomically:

async function* accept() {
    while (true) {
        try {
            const session = await endpoint.accept();
            if (!session) break; // endpoint is closed
            yield [null, session];
        } catch (err) {
            yield [err, null];
        }
    }
}

for await (const [err, session] of accept()) {
    //
}
Copy

Connect to a peer.

Get the local address the underlying socket is bound to.

Get the number of connections (≈sessions) that are currently open.

Get QUIC activity stats.

Wait for all sessions on the endpoint to be cleanly shut down.

Waiting for this condition before exiting ensures that a good-faith effort is made to notify peers of recent session closes, whereas exiting immediately could force them to wait out the idle timeout period.

Does not proactively close existing sessions or cause incoming sessions to be rejected. Consider calling session.close() if that is desired.