Struct H2Config

pub struct H2Config<'a, E> { /* private fields */ }

A configuration builder for H2 server connections.

Implementations

impl<E> H2Config<'_, E>

pub fn initial_stream_window_size( &mut self, sz: impl Into<Option<u32>>, ) -> &mut H2Config<'_, E>

Sets the SETTINGS_INITIAL_WINDOW_SIZE option for HTTP2 stream-level flow control.

Passing None will do nothing.

If not set, hyper will use a default.

pub fn initial_connection_window_size( &mut self, sz: impl Into<Option<u32>>, ) -> &mut H2Config<'_, E>

Sets the max connection-level flow control for HTTP2.

Passing None will do nothing.

If not set, hyper will use a default.

pub fn adaptive_window(&mut self, enabled: bool) -> &mut H2Config<'_, E>

Sets whether to use an adaptive flow control.

Enabling this will override the limits set in http2_initial_stream_window_size and http2_initial_connection_window_size.

pub fn max_frame_size( &mut self, sz: impl Into<Option<u32>>, ) -> &mut H2Config<'_, E>

Sets the maximum frame size to use for HTTP2.

Passing None will do nothing.

If not set, hyper will use a default.

pub fn max_concurrent_streams( &mut self, max: impl Into<Option<u32>>, ) -> &mut H2Config<'_, E>

Sets the SETTINGS_MAX_CONCURRENT_STREAMS option for HTTP2 connections.

Default is no limit (std::u32::MAX). Passing None will do nothing.

pub fn keep_alive_interval( &mut self, interval: impl Into<Option<Duration>>, ) -> &mut H2Config<'_, E>

Sets an interval for HTTP2 Ping frames should be sent to keep a connection alive.

Pass None to disable HTTP2 keep-alive.

Default is currently disabled.

Cargo Feature

pub fn keep_alive_timeout(&mut self, timeout: Duration) -> &mut H2Config<'_, E>

Sets a timeout for receiving an acknowledgement of the keep-alive ping.

If the ping is not acknowledged within the timeout, the connection will be closed. Does nothing if http2_keep_alive_interval is disabled.

Default is 20 seconds.

Cargo Feature

pub fn max_send_buf_size(&mut self, max: usize) -> &mut H2Config<'_, E>

Set the maximum write buffer size for each H2 stream.

Default is currently ~400KB, but may change.

Panics

The value must be no larger than u32::MAX.

pub fn enable_connect_protocol(&mut self) -> &mut H2Config<'_, E>

Enables the extended CONNECT protocol.

pub fn max_header_list_size(&mut self, max: u32) -> &mut H2Config<'_, E>

Sets the max size of received header frames.

Default is currently ~16MB, but may change.

pub fn timer<M>(&mut self, timer: M) -> &mut H2Config<'_, E>

where M: Timer + Send + Sync + 'static,

Set the timer used in background tasks.

Trait Implementations

impl<'a, E> Debug for H2Config<'a, E>

where E: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.