Package io.github.mahmoudimus.quic

package io.github.mahmoudimus.quic

A dependency-free QUIC transport (RFC 9000, 9001, 9002, 9221, 9369). This package holds the shared primitives (VarInt, ConnectionId, QuicVersion, ...) and the blocking API built for virtual threads: QuicServer and QuicClient own a UDP socket each, and hand out QuicConnections whose QuicStreams are read and written as InputStreams and OutputStreams.

The protocol itself is sans-I/O, in io.github.mahmoudimus.quic.connection: the I/O layer here only moves datagrams and wakes connections up.

Related Packages

Package	Description
io.github.mahmoudimus.quic.congestion	Congestion control for QUIC (RFC 9002 section 7), ported from quinn-proto's congestion module: the Controller interface, NewReno (RFC 9002), Cubic (RFC 9438, the default, as in quinn), the experimental Bbr (quinn's BBRv1-style port) and the RttEstimator they read.
io.github.mahmoudimus.quic.connection	The sans-I/O QUIC connection and endpoint, ported from quinn-proto: the Connection state machine (handshake, packet assembly and processing, key updates, closing and draining), the Endpoint that routes datagrams and answers with Version Negotiation, Retry and stateless resets, their configurations (TransportConfig, ServerConfig, ClientConfig, EndpointConfig), and the building blocks they are made of: range sets (RangeSet), reassembly of received data (Assembler), buffering of sent data (SendBuffer), streams and flow control (StreamsState), packet number spaces and ACK generation (PacketSpace), loss detection (Recovery), pacing (Pacer), path MTU discovery (MtuDiscovery) and timers (TimerTable).
io.github.mahmoudimus.quic.crypto	QUIC packet protection (RFC 9001 section 5): AEAD payload keys, header protection keys, Initial keys per version, key updates and the Retry integrity tag.
io.github.mahmoudimus.quic.frame	QUIC frames (RFC 9000 section 19, RFC 9221 DATAGRAM, and the ACK frequency extension): a sealed Frame hierarchy, its encoders and a validating decoder.
io.github.mahmoudimus.quic.packet	QUIC packets (RFC 9000 section 17, RFC 9369): header encoding and partial decoding, packet number truncation and recovery, coalesced datagrams, and protecting and unprotecting whole packets in place.
io.github.mahmoudimus.quic.params	QUIC transport parameters (RFC 9000 section 18), carried in the TLS quic_transport_parameters extension.
io.github.mahmoudimus.quic.tls	A TLS 1.3 handshake (RFC 8446) for QUIC (RFC 9001), client and server, ported from rustls with quinn's session interface.
io.github.mahmoudimus.quic.token	Address validation tokens (RFC 9000 section 8.1), ported from quinn-proto's token.rs and bloom_token_log.rs: Retry and NEW_TOKEN tokens sealed with AES-256-GCM under a key the server holds (TokenKey), their validation with expiry and address binding (TokenValidator), and a bounded replay log (BloomTokenLog); on the client, where NEW_TOKEN tokens wait for the next connection (TokenStore, TokenMemoryCache).

Class	Description
CipherSuite	The TLS 1.3 cipher suites QUIC can use (RFC 9001 section 5.3), with what packet protection needs to know about each: its HKDF hash, AEAD and key length.
ConnectionId	A QUIC connection ID (RFC 9000 section 5.1): 0 to 20 opaque bytes with value semantics.
EncryptionLevel	The four QUIC encryption levels (RFC 9001 section 4), each with its own keys.
EndpointStats	What a QUIC endpoint answered itself, without a connection: from QuicServer.endpointStats() and QuicClient.endpointStats().
Hkdf	HKDF (RFC 5869) over an HMAC, and the HKDF-Expand-Label of TLS 1.3 (RFC 8446 section 7.1) that QUIC uses for its secrets and keys (RFC 9001 section 5.1).
QuicClient	A QUIC client endpoint on one UDP socket, from which any number of connections can be made.
QuicConnection	A QUIC connection with a blocking API made for virtual threads: open and accept streams, read and write them as InputStreams and OutputStreams, send and receive datagrams.
QuicConnection.Observer	Learns of an endpoint's connections as they open, complete their handshakes and close, for statistics: set with QuicServer.observe(io.github.mahmoudimus.quic.QuicConnection.Observer) or QuicClient.observe(io.github.mahmoudimus.quic.QuicConnection.Observer).
QuicConnection.Stats	Connection statistics.
QuicConnectionException	A blocking operation failed because its connection ended, or could not be established.
QuicException	A QUIC connection error (RFC 9000 section 20), carrying the error code a CONNECTION_CLOSE frame sends to the peer.
QuicServer	A QUIC server on one UDP socket.
QuicServer.DatagramFilter	Sees the datagrams a server receives that none of its connections claims (by Destination Connection ID) before its endpoint does: a client's first Initial, packets of unknown versions, packets for connections the server does not know.
QuicServer.DatagramSink	Where an unbound server's datagrams go: the transport it runs over instead of a socket.
QuicStream	One QUIC stream of a QuicConnection, with blocking InputStream and OutputStream views.
QuicStreamException	A stream operation failed because the peer abandoned the stream: it reset the stream (RESET_STREAM, seen by a reader) or asked this side to stop sending (STOP_SENDING, seen by a writer).
QuicStreamException.Kind	How the peer abandoned the stream.
QuicVersion	The QUIC versions this module speaks: version 1 (RFC 9000) and version 2 (RFC 9369).
Secrets	The traffic secrets for one encryption level, as the TLS handshake hands them to packet protection: one secret per direction and the cipher suite they are for.
StatelessResetToken	A 16-byte stateless reset token (RFC 9000 section 10.3), as carried in NEW_CONNECTION_ID frames, the stateless_reset_token transport parameter and the tail of a Stateless Reset.
VarInt	QUIC variable-length integers (RFC 9000 section 16): values below 262, encoded in 1, 2, 4 or 8 bytes with the length in the two most significant bits of the first byte.