Struct hyper::server::Builder [−][src]
pub struct Builder<I, E = Exec> { /* fields omitted */ }
server
and (crate features http1
or http2
) only.Expand description
A builder for a Server
.
Implementations
Start a new builder, wrapping an incoming stream and low-level options.
For a more convenient constructor, see Server::bind
.
This is supported on crate feature http1
only.
http1
only.Sets whether to use keep-alive for HTTP/1 connections.
Default is true
.
This is supported on crate feature http1
only.
http1
only.Set whether HTTP/1 connections should support half-closures.
Clients can chose to shutdown their write-side while waiting
for the server to respond. Setting this to true
will
prevent closing the connection immediately if read
detects an EOF in the middle of a request.
Default is false
.
This is supported on crate feature http1
only.
http1
only.Set the maximum buffer size.
Default is ~ 400kb.
Set whether HTTP/1 connections should try to use vectored writes, or always flatten into a single buffer.
Note that setting this to false may mean more copies of body data, but may also improve performance when an IO transport doesn’t support vectored writes well, such as most TLS implementations.
Setting this to true will force hyper to use queued strategy which may eliminate unnecessary cloning on some TLS backends
Default is auto
. In this mode hyper will try to guess which
mode to use
This is supported on crate feature http1
only.
http1
only.Set whether HTTP/1 connections will write header names as title case at the socket level.
Note that this setting does not affect HTTP/2.
Default is false.
This is supported on crate feature http1
only.
http1
only.Set whether to support preserving original header cases.
Currently, this will record the original cases received, and store them
in a private extension on the Request
. It will also look for and use
such an extension in any provided Response
.
Since the relevant extension is still private, there is no way to interact with the original cases. The only effect this can have now is to forward the cases in a proxy-like fashion.
Note that this setting does not affect HTTP/2.
Default is false.
This is supported on crate features http1
and runtime
only.
http1
and runtime
only.Set a timeout for reading client request headers. If a client does not transmit the entire header within this time, the connection is closed.
Default is None.
This is supported on crate feature http1
only.
http1
only.Sets whether HTTP/1 is required.
Default is false
.
This is supported on crate feature http2
only.
http2
only.Sets whether HTTP/2 is required.
Default is false
.
This is supported on crate feature http2
only.
http2
only.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.
This is supported on crate feature http2
only.
http2
only.Sets the max connection-level flow control for HTTP2
Passing None
will do nothing.
If not set, hyper will use a default.
This is supported on crate feature http2
only.
http2
only.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
.
This is supported on crate feature http2
only.
http2
only.Sets the maximum frame size to use for HTTP2.
Passing None
will do nothing.
If not set, hyper will use a default.
This is supported on crate feature http2
only.
http2
only.Sets the SETTINGS_MAX_CONCURRENT_STREAMS
option for HTTP2
connections.
Default is no limit (std::u32::MAX
). Passing None
will do nothing.
This is supported on crate feature http2
only.
http2
only.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
Requires the runtime
cargo feature to be enabled.
This is supported on crate feature http2
only.
http2
only.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
Requires the runtime
cargo feature to be enabled.
This is supported on crate feature http2
only.
http2
only.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
.
Sets the Executor
to deal with connection tasks.
Default is tokio::spawn
.
pub fn serve<S, B>(self, new_service: S) -> Server<I, S, E>ⓘNotable traits for Server<I, S, E>impl<I, IO, IE, S, B, E> Future for Server<I, S, E> where
I: Accept<Conn = IO, Error = IE>,
IE: Into<Box<dyn StdError + Send + Sync>>,
IO: AsyncRead + AsyncWrite + Unpin + Send + 'static,
S: MakeServiceRef<IO, Body, ResBody = B>,
S::Error: Into<Box<dyn StdError + Send + Sync>>,
B: HttpBody + 'static,
B::Error: Into<Box<dyn StdError + Send + Sync>>,
E: ConnStreamExec<<S::Service as HttpService<Body>>::Future, B>,
E: NewSvcExec<IO, S::Future, S::Service, E, NoopWatcher>, type Output = Result<()>;
where
I: Accept,
I::Error: Into<Box<dyn StdError + Send + Sync>>,
I::Conn: AsyncRead + AsyncWrite + Unpin + Send + 'static,
S: MakeServiceRef<I::Conn, Body, ResBody = B>,
S::Error: Into<Box<dyn StdError + Send + Sync>>,
B: HttpBody + 'static,
B::Error: Into<Box<dyn StdError + Send + Sync>>,
E: NewSvcExec<I::Conn, S::Future, S::Service, E, NoopWatcher>,
E: ConnStreamExec<<S::Service as HttpService<Body>>::Future, B>,
pub fn serve<S, B>(self, new_service: S) -> Server<I, S, E>ⓘNotable traits for Server<I, S, E>impl<I, IO, IE, S, B, E> Future for Server<I, S, E> where
I: Accept<Conn = IO, Error = IE>,
IE: Into<Box<dyn StdError + Send + Sync>>,
IO: AsyncRead + AsyncWrite + Unpin + Send + 'static,
S: MakeServiceRef<IO, Body, ResBody = B>,
S::Error: Into<Box<dyn StdError + Send + Sync>>,
B: HttpBody + 'static,
B::Error: Into<Box<dyn StdError + Send + Sync>>,
E: ConnStreamExec<<S::Service as HttpService<Body>>::Future, B>,
E: NewSvcExec<IO, S::Future, S::Service, E, NoopWatcher>, type Output = Result<()>;
where
I: Accept,
I::Error: Into<Box<dyn StdError + Send + Sync>>,
I::Conn: AsyncRead + AsyncWrite + Unpin + Send + 'static,
S: MakeServiceRef<I::Conn, Body, ResBody = B>,
S::Error: Into<Box<dyn StdError + Send + Sync>>,
B: HttpBody + 'static,
B::Error: Into<Box<dyn StdError + Send + Sync>>,
E: NewSvcExec<I::Conn, S::Future, S::Service, E, NoopWatcher>,
E: ConnStreamExec<<S::Service as HttpService<Body>>::Future, B>,
impl<I, IO, IE, S, B, E> Future for Server<I, S, E> where
I: Accept<Conn = IO, Error = IE>,
IE: Into<Box<dyn StdError + Send + Sync>>,
IO: AsyncRead + AsyncWrite + Unpin + Send + 'static,
S: MakeServiceRef<IO, Body, ResBody = B>,
S::Error: Into<Box<dyn StdError + Send + Sync>>,
B: HttpBody + 'static,
B::Error: Into<Box<dyn StdError + Send + Sync>>,
E: ConnStreamExec<<S::Service as HttpService<Body>>::Future, B>,
E: NewSvcExec<IO, S::Future, S::Service, E, NoopWatcher>, type Output = Result<()>;
Consume this Builder
, creating a Server
.
Example
use hyper::{Body, Error, Response, Server};
use hyper::service::{make_service_fn, service_fn};
// Construct our SocketAddr to listen on...
let addr = ([127, 0, 0, 1], 3000).into();
// And a MakeService to handle each connection...
let make_svc = make_service_fn(|_| async {
Ok::<_, Error>(service_fn(|_req| async {
Ok::<_, Error>(Response::new(Body::from("Hello World")))
}))
});
// Then bind and serve...
let server = Server::bind(&addr)
.serve(make_svc);
// Run forever-ish...
if let Err(err) = server.await {
eprintln!("server error: {}", err);
}
Set whether TCP keepalive messages are enabled on accepted connections.
If None
is specified, keepalive is disabled, otherwise the duration
specified will be the time to remain idle before sending TCP keepalive
probes.
Set the value of TCP_NODELAY
option for accepted connections.
Set whether to sleep on accept errors.
A possible scenario is that the process has hit the max open files allowed, and so trying to accept a new connection will fail with EMFILE. In some cases, it’s preferable to just wait for some time, if the application will likely close some files (or connections), and try to accept the connection again. If this option is true, the error will be logged at the error level, since it is still a big deal, and then the listener will sleep for 1 second.
In other cases, hitting the max open files should be treat similarly to being out-of-memory, and simply error (and shutdown). Setting this option to false will allow that.
For more details see AddrIncoming::set_sleep_on_errors
Trait Implementations
Auto Trait Implementations
impl<I, E> RefUnwindSafe for Builder<I, E> where
E: RefUnwindSafe,
I: RefUnwindSafe,
impl<I, E> UnwindSafe for Builder<I, E> where
E: UnwindSafe,
I: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more