Struct Builder

pub struct Builder<E> { /* private fields */ }

Available on crate feature server only.

A configuration builder for HTTP/2 server connections.

Note: The default values of options are not considered stable. They are subject to change at any time.

Implementations

impl<E> Builder<E>

pub fn new(exec: E) -> Builder<E>

Create a new connection builder.

This starts with the default options, and an executor which is a type that implements Http2ServerConnExec trait.

pub fn max_pending_accept_reset_streams( &mut self, max: impl Into<Option<usize>>, ) -> &mut Builder<E>

Configures the maximum number of pending reset streams allowed before a GOAWAY will be sent.

This will default to the default value set by the h2 crate. As of v0.4.0, it is 20.

See https://github.com/hyperium/hyper/issues/2877 for more information.

pub fn max_local_error_reset_streams( &mut self, max: impl Into<Option<usize>>, ) -> &mut Builder<E>

Configures the maximum number of local reset streams allowed before a GOAWAY will be sent.

If not set, hyper will use a default, currently of 1024.

If None is supplied, hyper will not apply any limit. This is not advised, as it can potentially expose servers to DOS vulnerabilities.

See https://rustsec.org/advisories/RUSTSEC-2024-0003.html for more information.

pub fn initial_stream_window_size( &mut self, sz: impl Into<Option<u32>>, ) -> &mut Builder<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 Builder<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 Builder<E>

Sets whether to use an adaptive flow control.

Enabling this will override the limits set in initial_stream_window_size and initial_connection_window_size.

pub fn max_frame_size(&mut self, sz: impl Into<Option<u32>>) -> &mut Builder<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 Builder<E>

Sets the SETTINGS_MAX_CONCURRENT_STREAMS option for HTTP2 connections.

Default is 200, but not part of the stability of hyper. It could change in a future release. You are encouraged to set your own limit.

Passing None will remove any limit.

pub fn keep_alive_interval( &mut self, interval: impl Into<Option<Duration>>, ) -> &mut Builder<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.

pub fn keep_alive_timeout(&mut self, timeout: Duration) -> &mut Builder<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 keep_alive_interval is disabled.

Default is 20 seconds.

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

Set the maximum write buffer size for each HTTP/2 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 Builder<E>

Enables the extended CONNECT protocol.

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

Sets the max size of received header frames.

Default is currently 16KB, but can change.

pub fn timer<M>(&mut self, timer: M) -> &mut Builder<E>

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

Set the timer used in background tasks.

pub fn auto_date_header(&mut self, enabled: bool) -> &mut Builder<E>

Set whether the date header should be included in HTTP responses.

Note that including the date header is recommended by RFC 7231.

Default is true.

pub fn serve_connection<S, I, Bd>( &self, io: I, service: S, ) -> Connection<I, S, E>

where S: HttpService<Incoming, ResBody = Bd>, <S as HttpService<Incoming>>::Error: Into<Box<dyn Error + Send + Sync>>, Bd: Body + 'static, <Bd as Body>::Error: Into<Box<dyn Error + Send + Sync>>, I: Read + Write + Unpin, E: Http2ServerConnExec<<S as HttpService<Incoming>>::Future, Bd>,

Bind a connection together with a Service.

This returns a Future that must be polled in order for HTTP to be driven on the connection.

Trait Implementations

impl<E> Clone for Builder<E>

where E: Clone,

fn clone(&self) -> Builder<E>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<E> Debug for Builder<E>

where E: Debug,

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

Formats the value using the given formatter.

impl<S, IO, BIn, BOut, E> Protocol<S, IO, BIn> for Builder<E>

where S: Service<Request<BIn>, Response = Response<BOut>> + Clone + 'static, S::Future: 'static, S::Error: Into<Box<dyn Error + Send + Sync>>, BIn: Body + From<Incoming> + Send + 'static, BOut: Body + Send + 'static, BOut::Error: Into<Box<dyn Error + Send + Sync>>, BOut::Data: Send + 'static, IO: AsyncRead + AsyncWrite + Unpin + 'static, E: Http2ServerConnExec<TowerHyperFuture<IncomingRequestService<S, BIn, BOut>, Request<Incoming>>, BOut> + Clone + Send + 'static,

type ResponseBody = BOut

The body type for the protocol.

type Connection = Connection<TokioIo<IO>, TowerHyperService<IncomingRequestService<S, BIn, BOut>>, E>

The connection future, used to drive a connection IO to completion.

type Error = Error

The error when a connection has a problem.

fn serve_connection_with_upgrades( &self, stream: IO, service: S, ) -> Self::Connection

Serve a connection with possible upgrades.