Source code
Revision control
Copy as Markdown
Other Tools
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// option. This file may not be copied, modified, or distributed
// except according to those terms.
use std::cmp::min;
use neqo_common::qwarn;
use neqo_qpack as qpack;
use neqo_transport::ConnectionParameters;
const QPACK_MAX_TABLE_SIZE_DEFAULT: u64 = 65536;
const QPACK_TABLE_SIZE_LIMIT: u64 = (1 << 30) - 1;
const QPACK_MAX_BLOCKED_STREAMS_DEFAULT: u16 = 20;
const MAX_PUSH_STREAM_DEFAULT: u64 = 0;
const WEBTRANSPORT_DEFAULT: bool = false;
/// Do not support HTTP Extended CONNECT by default.
const CONNECT_DEFAULT: bool = false;
const HTTP3_DATAGRAM_DEFAULT: bool = true;
#[derive(Debug, Clone)]
pub struct Http3Parameters {
conn_params: ConnectionParameters,
qpack_settings: qpack::Settings,
max_concurrent_push_streams: u64,
webtransport: bool,
/// HTTP Extended CONNECT
connect: bool,
http3_datagram: bool,
}
impl Default for Http3Parameters {
fn default() -> Self {
Self {
conn_params: ConnectionParameters::default(),
qpack_settings: qpack::Settings {
max_table_size_encoder: QPACK_MAX_TABLE_SIZE_DEFAULT,
max_table_size_decoder: QPACK_MAX_TABLE_SIZE_DEFAULT,
max_blocked_streams: QPACK_MAX_BLOCKED_STREAMS_DEFAULT,
},
max_concurrent_push_streams: MAX_PUSH_STREAM_DEFAULT,
webtransport: WEBTRANSPORT_DEFAULT,
connect: CONNECT_DEFAULT,
http3_datagram: HTTP3_DATAGRAM_DEFAULT,
}
}
}
impl Http3Parameters {
#[must_use]
pub const fn get_connection_parameters(&self) -> &ConnectionParameters {
&self.conn_params
}
#[must_use]
pub fn connection_parameters(mut self, conn_params: ConnectionParameters) -> Self {
self.conn_params = conn_params;
self
}
/// # Panics
///
/// The table size must be smaller than 1 << 30 by the spec.
#[must_use]
pub fn max_table_size_encoder(mut self, mut max_table: u64) -> Self {
assert!(max_table <= QPACK_TABLE_SIZE_LIMIT);
max_table = min(max_table, QPACK_TABLE_SIZE_LIMIT);
self.qpack_settings.max_table_size_encoder = max_table;
self
}
/// # Panics
///
/// The table size must be smaller than 1 << 30 by the spec.
#[must_use]
pub fn max_table_size_decoder(mut self, mut max_table: u64) -> Self {
assert!(max_table <= QPACK_TABLE_SIZE_LIMIT);
max_table = min(max_table, QPACK_TABLE_SIZE_LIMIT);
self.qpack_settings.max_table_size_decoder = max_table;
self
}
#[must_use]
pub const fn get_max_table_size_decoder(&self) -> u64 {
self.qpack_settings.max_table_size_decoder
}
#[must_use]
pub const fn max_blocked_streams(mut self, max_blocked: u16) -> Self {
self.qpack_settings.max_blocked_streams = max_blocked;
self
}
#[must_use]
pub const fn get_max_blocked_streams(&self) -> u16 {
self.qpack_settings.max_blocked_streams
}
#[must_use]
pub const fn get_qpack_settings(&self) -> &qpack::Settings {
&self.qpack_settings
}
#[must_use]
pub const fn max_concurrent_push_streams(mut self, max_push_streams: u64) -> Self {
self.max_concurrent_push_streams = max_push_streams;
self
}
#[must_use]
pub const fn get_max_concurrent_push_streams(&self) -> u64 {
self.max_concurrent_push_streams
}
#[must_use]
pub const fn webtransport(mut self, webtransport: bool) -> Self {
self.webtransport = webtransport;
self
}
#[must_use]
pub const fn get_webtransport(&self) -> bool {
self.webtransport
}
/// Setter for HTTP Extended CONNECT support.
#[must_use]
pub const fn connect(mut self, connect: bool) -> Self {
self.connect = connect;
self
}
/// Getter for HTTP Extended CONNECT support.
#[must_use]
pub const fn get_connect(&self) -> bool {
self.connect
}
#[must_use]
pub const fn http3_datagram(mut self, http3_datagram: bool) -> Self {
self.http3_datagram = http3_datagram;
self
}
#[must_use]
pub fn get_http3_datagram(&self) -> bool {
if self.http3_datagram && self.conn_params.get_datagram_size() == 0 {
qwarn!("HTTP/3 setting SETTINGS_HTTP3_DATAGRAM is enabled but QUIC transport parameter max_datagram_frame_size is 0.");
debug_assert!(false);
}
self.http3_datagram
}
}
#[cfg(test)]
#[cfg_attr(coverage_nightly, coverage(off))]
mod tests {
use neqo_transport::ConnectionParameters;
use crate::Http3Parameters;
#[test]
#[cfg(debug_assertions)]
#[should_panic(expected = "assertion failed: false")]
fn get_http3_datagram_debug_panic_on_mismatch() {
let params = Http3Parameters::default()
.connection_parameters(ConnectionParameters::default().datagram_size(0))
.http3_datagram(true);
assert!(params.get_http3_datagram());
}
#[test]
fn max_table_size_accepts_limit() {
// QPACK spec limits table size to (1 << 30) - 1.
let limit = (1 << 30) - 1;
let params = Http3Parameters::default()
.max_table_size_encoder(limit)
.max_table_size_decoder(limit);
assert_eq!(params.get_qpack_settings().max_table_size_encoder, limit);
assert_eq!(params.get_qpack_settings().max_table_size_decoder, limit);
}
#[test]
#[should_panic(expected = "assertion")]
fn max_table_size_encoder_rejects_above_limit() {
_ = Http3Parameters::default().max_table_size_encoder(1 << 30);
}
#[test]
#[should_panic(expected = "assertion")]
fn max_table_size_decoder_rejects_above_limit() {
_ = Http3Parameters::default().max_table_size_decoder(1 << 30);
}
#[test]
fn http3_datagram_setting() {
let params = Http3Parameters::default()
.connection_parameters(ConnectionParameters::default().datagram_size(1200))
.http3_datagram(true);
assert!(params.get_http3_datagram());
}
}