pub struct Builder<E> { /* private fields */ }
server
only.Expand description
A configuration builder for HTTP/2 server connections.
Implementations§
source§impl<E> Builder<E>
impl<E> Builder<E>
sourcepub fn new(exec: E) -> Self
pub fn new(exec: E) -> Self
Create a new connection builder.
This starts with the default options, and an executor which is a type
that implements Http2ConnExec
trait.
sourcepub fn initial_stream_window_size(
&mut self,
sz: impl Into<Option<u32>>
) -> &mut Self
pub fn initial_stream_window_size( &mut self, sz: impl Into<Option<u32>> ) -> &mut Self
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.
sourcepub fn initial_connection_window_size(
&mut self,
sz: impl Into<Option<u32>>
) -> &mut Self
pub fn initial_connection_window_size( &mut self, sz: impl Into<Option<u32>> ) -> &mut Self
Sets the max connection-level flow control for HTTP2.
Passing None
will do nothing.
If not set, hyper will use a default.
sourcepub fn adaptive_window(&mut self, enabled: bool) -> &mut Self
pub fn adaptive_window(&mut self, enabled: bool) -> &mut Self
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
.
sourcepub fn max_frame_size(&mut self, sz: impl Into<Option<u32>>) -> &mut Self
pub fn max_frame_size(&mut self, sz: impl Into<Option<u32>>) -> &mut Self
Sets the maximum frame size to use for HTTP2.
Passing None
will do nothing.
If not set, hyper will use a default.
sourcepub fn max_concurrent_streams(
&mut self,
max: impl Into<Option<u32>>
) -> &mut Self
pub fn max_concurrent_streams( &mut self, max: impl Into<Option<u32>> ) -> &mut Self
Sets the SETTINGS_MAX_CONCURRENT_STREAMS
option for HTTP2
connections.
Default is no limit (std::u32::MAX
). Passing None
will do nothing.
sourcepub fn keep_alive_interval(
&mut self,
interval: impl Into<Option<Duration>>
) -> &mut Self
pub fn keep_alive_interval( &mut self, interval: impl Into<Option<Duration>> ) -> &mut Self
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
sourcepub fn keep_alive_timeout(&mut self, timeout: Duration) -> &mut Self
pub fn keep_alive_timeout(&mut self, timeout: Duration) -> &mut Self
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.
Cargo Feature
sourcepub fn max_send_buf_size(&mut self, max: usize) -> &mut Self
pub fn max_send_buf_size(&mut self, max: usize) -> &mut Self
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
.
sourcepub fn enable_connect_protocol(&mut self) -> &mut Self
pub fn enable_connect_protocol(&mut self) -> &mut Self
Enables the extended CONNECT protocol.
sourcepub fn max_header_list_size(&mut self, max: u32) -> &mut Self
pub fn max_header_list_size(&mut self, max: u32) -> &mut Self
Sets the max size of received header frames.
Default is currently ~16MB, but may change.
sourcepub fn timer<M>(&mut self, timer: M) -> &mut Selfwhere
M: Timer + Send + Sync + 'static,
pub fn timer<M>(&mut self, timer: M) -> &mut Selfwhere M: Timer + Send + Sync + 'static,
Set the timer used in background tasks.
sourcepub fn serve_connection<S, I, Bd>(&self, io: I, service: S) -> Connection<I, S, E> ⓘwhere
S: HttpService<IncomingBody, ResBody = Bd>,
S::Error: Into<Box<dyn StdError + Send + Sync>>,
Bd: Body + 'static,
Bd::Error: Into<Box<dyn StdError + Send + Sync>>,
I: AsyncRead + AsyncWrite + Unpin,
E: Http2ConnExec<S::Future, Bd>,
pub fn serve_connection<S, I, Bd>(&self, io: I, service: S) -> Connection<I, S, E> ⓘwhere S: HttpService<IncomingBody, ResBody = Bd>, S::Error: Into<Box<dyn StdError + Send + Sync>>, Bd: Body + 'static, Bd::Error: Into<Box<dyn StdError + Send + Sync>>, I: AsyncRead + AsyncWrite + Unpin, E: Http2ConnExec<S::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.