1 use std::error::Error as StdError; 2 use std::fmt; 3 use std::future::Future; 4 use std::marker::Unpin; 5 #[cfg(feature = "tcp")] 6 use std::net::{SocketAddr, TcpListener as StdTcpListener}; 7 use std::pin::Pin; 8 use std::task::{Context, Poll}; 9 #[cfg(feature = "tcp")] 10 use std::time::Duration; 11 12 use pin_project_lite::pin_project; 13 14 use tokio::io::{AsyncRead, AsyncWrite}; 15 use tracing::trace; 16 17 use super::accept::Accept; 18 #[cfg(all(feature = "tcp"))] 19 use super::tcp::AddrIncoming; 20 use crate::body::{Body, HttpBody}; 21 use crate::common::exec::Exec; 22 use crate::common::exec::{ConnStreamExec, NewSvcExec}; 23 // Renamed `Http` as `Http_` for now so that people upgrading don't see an 24 // error that `hyper::server::Http` is private... 25 use super::conn::{Connection, Http as Http_, UpgradeableConnection}; 26 use super::shutdown::{Graceful, GracefulWatcher}; 27 use crate::service::{HttpService, MakeServiceRef}; 28 29 use self::new_svc::NewSvcTask; 30 31 pin_project! { 32 /// A listening HTTP server that accepts connections in both HTTP1 and HTTP2 by default. 33 /// 34 /// `Server` is a `Future` mapping a bound listener with a set of service 35 /// handlers. It is built using the [`Builder`](Builder), and the future 36 /// completes when the server has been shutdown. It should be run by an 37 /// `Executor`. 38 pub struct Server<I, S, E = Exec> { 39 #[pin] 40 incoming: I, 41 make_service: S, 42 protocol: Http_<E>, 43 } 44 } 45 46 /// A builder for a [`Server`](Server). 47 #[derive(Debug)] 48 #[cfg_attr(docsrs, doc(cfg(any(feature = "http1", feature = "http2"))))] 49 pub struct Builder<I, E = Exec> { 50 incoming: I, 51 protocol: Http_<E>, 52 } 53 54 // ===== impl Server ===== 55 56 #[cfg_attr(docsrs, doc(cfg(any(feature = "http1", feature = "http2"))))] 57 impl<I> Server<I, ()> { 58 /// Starts a [`Builder`](Builder) with the provided incoming stream. builder(incoming: I) -> Builder<I>59 pub fn builder(incoming: I) -> Builder<I> { 60 Builder { 61 incoming, 62 protocol: Http_::new(), 63 } 64 } 65 } 66 67 #[cfg(feature = "tcp")] 68 #[cfg_attr( 69 docsrs, 70 doc(cfg(all(feature = "tcp", any(feature = "http1", feature = "http2")))) 71 )] 72 impl Server<AddrIncoming, ()> { 73 /// Binds to the provided address, and returns a [`Builder`](Builder). 74 /// 75 /// # Panics 76 /// 77 /// This method will panic if binding to the address fails. For a method 78 /// to bind to an address and return a `Result`, see `Server::try_bind`. bind(addr: &SocketAddr) -> Builder<AddrIncoming>79 pub fn bind(addr: &SocketAddr) -> Builder<AddrIncoming> { 80 let incoming = AddrIncoming::new(addr).unwrap_or_else(|e| { 81 panic!("error binding to {}: {}", addr, e); 82 }); 83 Server::builder(incoming) 84 } 85 86 /// Tries to bind to the provided address, and returns a [`Builder`](Builder). try_bind(addr: &SocketAddr) -> crate::Result<Builder<AddrIncoming>>87 pub fn try_bind(addr: &SocketAddr) -> crate::Result<Builder<AddrIncoming>> { 88 AddrIncoming::new(addr).map(Server::builder) 89 } 90 91 /// Create a new instance from a `std::net::TcpListener` instance. from_tcp(listener: StdTcpListener) -> Result<Builder<AddrIncoming>, crate::Error>92 pub fn from_tcp(listener: StdTcpListener) -> Result<Builder<AddrIncoming>, crate::Error> { 93 AddrIncoming::from_std(listener).map(Server::builder) 94 } 95 } 96 97 #[cfg(feature = "tcp")] 98 #[cfg_attr( 99 docsrs, 100 doc(cfg(all(feature = "tcp", any(feature = "http1", feature = "http2")))) 101 )] 102 impl<S, E> Server<AddrIncoming, S, E> { 103 /// Returns the local address that this server is bound to. local_addr(&self) -> SocketAddr104 pub fn local_addr(&self) -> SocketAddr { 105 self.incoming.local_addr() 106 } 107 } 108 109 #[cfg_attr(docsrs, doc(cfg(any(feature = "http1", feature = "http2"))))] 110 impl<I, IO, IE, S, E, B> Server<I, S, E> 111 where 112 I: Accept<Conn = IO, Error = IE>, 113 IE: Into<Box<dyn StdError + Send + Sync>>, 114 IO: AsyncRead + AsyncWrite + Unpin + Send + 'static, 115 S: MakeServiceRef<IO, Body, ResBody = B>, 116 S::Error: Into<Box<dyn StdError + Send + Sync>>, 117 B: HttpBody + 'static, 118 B::Error: Into<Box<dyn StdError + Send + Sync>>, 119 E: ConnStreamExec<<S::Service as HttpService<Body>>::Future, B>, 120 { 121 /// Prepares a server to handle graceful shutdown when the provided future 122 /// completes. 123 /// 124 /// # Example 125 /// 126 /// ``` 127 /// # fn main() {} 128 /// # #[cfg(feature = "tcp")] 129 /// # async fn run() { 130 /// # use hyper::{Body, Response, Server, Error}; 131 /// # use hyper::service::{make_service_fn, service_fn}; 132 /// # let make_service = make_service_fn(|_| async { 133 /// # Ok::<_, Error>(service_fn(|_req| async { 134 /// # Ok::<_, Error>(Response::new(Body::from("Hello World"))) 135 /// # })) 136 /// # }); 137 /// // Make a server from the previous examples... 138 /// let server = Server::bind(&([127, 0, 0, 1], 3000).into()) 139 /// .serve(make_service); 140 /// 141 /// // Prepare some signal for when the server should start shutting down... 142 /// let (tx, rx) = tokio::sync::oneshot::channel::<()>(); 143 /// let graceful = server 144 /// .with_graceful_shutdown(async { 145 /// rx.await.ok(); 146 /// }); 147 /// 148 /// // Await the `server` receiving the signal... 149 /// if let Err(e) = graceful.await { 150 /// eprintln!("server error: {}", e); 151 /// } 152 /// 153 /// // And later, trigger the signal by calling `tx.send(())`. 154 /// let _ = tx.send(()); 155 /// # } 156 /// ``` with_graceful_shutdown<F>(self, signal: F) -> Graceful<I, S, F, E> where F: Future<Output = ()>, E: NewSvcExec<IO, S::Future, S::Service, E, GracefulWatcher>,157 pub fn with_graceful_shutdown<F>(self, signal: F) -> Graceful<I, S, F, E> 158 where 159 F: Future<Output = ()>, 160 E: NewSvcExec<IO, S::Future, S::Service, E, GracefulWatcher>, 161 { 162 Graceful::new(self, signal) 163 } 164 poll_next_( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<crate::Result<Connecting<IO, S::Future, E>>>>165 fn poll_next_( 166 self: Pin<&mut Self>, 167 cx: &mut Context<'_>, 168 ) -> Poll<Option<crate::Result<Connecting<IO, S::Future, E>>>> { 169 let me = self.project(); 170 match ready!(me.make_service.poll_ready_ref(cx)) { 171 Ok(()) => (), 172 Err(e) => { 173 trace!("make_service closed"); 174 return Poll::Ready(Some(Err(crate::Error::new_user_make_service(e)))); 175 } 176 } 177 178 if let Some(item) = ready!(me.incoming.poll_accept(cx)) { 179 let io = item.map_err(crate::Error::new_accept)?; 180 let new_fut = me.make_service.make_service_ref(&io); 181 Poll::Ready(Some(Ok(Connecting { 182 future: new_fut, 183 io: Some(io), 184 protocol: me.protocol.clone(), 185 }))) 186 } else { 187 Poll::Ready(None) 188 } 189 } 190 poll_watch<W>( mut self: Pin<&mut Self>, cx: &mut Context<'_>, watcher: &W, ) -> Poll<crate::Result<()>> where E: NewSvcExec<IO, S::Future, S::Service, E, W>, W: Watcher<IO, S::Service, E>,191 pub(super) fn poll_watch<W>( 192 mut self: Pin<&mut Self>, 193 cx: &mut Context<'_>, 194 watcher: &W, 195 ) -> Poll<crate::Result<()>> 196 where 197 E: NewSvcExec<IO, S::Future, S::Service, E, W>, 198 W: Watcher<IO, S::Service, E>, 199 { 200 loop { 201 if let Some(connecting) = ready!(self.as_mut().poll_next_(cx)?) { 202 let fut = NewSvcTask::new(connecting, watcher.clone()); 203 self.as_mut().project().protocol.exec.execute_new_svc(fut); 204 } else { 205 return Poll::Ready(Ok(())); 206 } 207 } 208 } 209 } 210 211 #[cfg_attr(docsrs, doc(cfg(any(feature = "http1", feature = "http2"))))] 212 impl<I, IO, IE, S, B, E> Future for Server<I, S, E> 213 where 214 I: Accept<Conn = IO, Error = IE>, 215 IE: Into<Box<dyn StdError + Send + Sync>>, 216 IO: AsyncRead + AsyncWrite + Unpin + Send + 'static, 217 S: MakeServiceRef<IO, Body, ResBody = B>, 218 S::Error: Into<Box<dyn StdError + Send + Sync>>, 219 B: HttpBody + 'static, 220 B::Error: Into<Box<dyn StdError + Send + Sync>>, 221 E: ConnStreamExec<<S::Service as HttpService<Body>>::Future, B>, 222 E: NewSvcExec<IO, S::Future, S::Service, E, NoopWatcher>, 223 { 224 type Output = crate::Result<()>; 225 poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>226 fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> { 227 self.poll_watch(cx, &NoopWatcher) 228 } 229 } 230 231 impl<I: fmt::Debug, S: fmt::Debug> fmt::Debug for Server<I, S> { fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result232 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { 233 let mut st = f.debug_struct("Server"); 234 st.field("listener", &self.incoming); 235 st.finish() 236 } 237 } 238 239 // ===== impl Builder ===== 240 241 #[cfg_attr(docsrs, doc(cfg(any(feature = "http1", feature = "http2"))))] 242 impl<I, E> Builder<I, E> { 243 /// Start a new builder, wrapping an incoming stream and low-level options. 244 /// 245 /// For a more convenient constructor, see [`Server::bind`](Server::bind). new(incoming: I, protocol: Http_<E>) -> Self246 pub fn new(incoming: I, protocol: Http_<E>) -> Self { 247 Builder { incoming, protocol } 248 } 249 250 /// Sets whether to use keep-alive for HTTP/1 connections. 251 /// 252 /// Default is `true`. 253 #[cfg(feature = "http1")] 254 #[cfg_attr(docsrs, doc(cfg(feature = "http1")))] http1_keepalive(mut self, val: bool) -> Self255 pub fn http1_keepalive(mut self, val: bool) -> Self { 256 self.protocol.http1_keep_alive(val); 257 self 258 } 259 260 /// Set whether HTTP/1 connections should support half-closures. 261 /// 262 /// Clients can chose to shutdown their write-side while waiting 263 /// for the server to respond. Setting this to `true` will 264 /// prevent closing the connection immediately if `read` 265 /// detects an EOF in the middle of a request. 266 /// 267 /// Default is `false`. 268 #[cfg(feature = "http1")] 269 #[cfg_attr(docsrs, doc(cfg(feature = "http1")))] http1_half_close(mut self, val: bool) -> Self270 pub fn http1_half_close(mut self, val: bool) -> Self { 271 self.protocol.http1_half_close(val); 272 self 273 } 274 275 /// Set the maximum buffer size. 276 /// 277 /// Default is ~ 400kb. 278 #[cfg(feature = "http1")] 279 #[cfg_attr(docsrs, doc(cfg(feature = "http1")))] http1_max_buf_size(mut self, val: usize) -> Self280 pub fn http1_max_buf_size(mut self, val: usize) -> Self { 281 self.protocol.max_buf_size(val); 282 self 283 } 284 285 // Sets whether to bunch up HTTP/1 writes until the read buffer is empty. 286 // 287 // This isn't really desirable in most cases, only really being useful in 288 // silly pipeline benchmarks. 289 #[doc(hidden)] 290 #[cfg(feature = "http1")] http1_pipeline_flush(mut self, val: bool) -> Self291 pub fn http1_pipeline_flush(mut self, val: bool) -> Self { 292 self.protocol.pipeline_flush(val); 293 self 294 } 295 296 /// Set whether HTTP/1 connections should try to use vectored writes, 297 /// or always flatten into a single buffer. 298 /// 299 /// Note that setting this to false may mean more copies of body data, 300 /// but may also improve performance when an IO transport doesn't 301 /// support vectored writes well, such as most TLS implementations. 302 /// 303 /// Setting this to true will force hyper to use queued strategy 304 /// which may eliminate unnecessary cloning on some TLS backends 305 /// 306 /// Default is `auto`. In this mode hyper will try to guess which 307 /// mode to use 308 #[cfg(feature = "http1")] http1_writev(mut self, enabled: bool) -> Self309 pub fn http1_writev(mut self, enabled: bool) -> Self { 310 self.protocol.http1_writev(enabled); 311 self 312 } 313 314 /// Set whether HTTP/1 connections will write header names as title case at 315 /// the socket level. 316 /// 317 /// Note that this setting does not affect HTTP/2. 318 /// 319 /// Default is false. 320 #[cfg(feature = "http1")] 321 #[cfg_attr(docsrs, doc(cfg(feature = "http1")))] http1_title_case_headers(mut self, val: bool) -> Self322 pub fn http1_title_case_headers(mut self, val: bool) -> Self { 323 self.protocol.http1_title_case_headers(val); 324 self 325 } 326 327 /// Set whether to support preserving original header cases. 328 /// 329 /// Currently, this will record the original cases received, and store them 330 /// in a private extension on the `Request`. It will also look for and use 331 /// such an extension in any provided `Response`. 332 /// 333 /// Since the relevant extension is still private, there is no way to 334 /// interact with the original cases. The only effect this can have now is 335 /// to forward the cases in a proxy-like fashion. 336 /// 337 /// Note that this setting does not affect HTTP/2. 338 /// 339 /// Default is false. 340 #[cfg(feature = "http1")] 341 #[cfg_attr(docsrs, doc(cfg(feature = "http1")))] http1_preserve_header_case(mut self, val: bool) -> Self342 pub fn http1_preserve_header_case(mut self, val: bool) -> Self { 343 self.protocol.http1_preserve_header_case(val); 344 self 345 } 346 347 /// Set a timeout for reading client request headers. If a client does not 348 /// transmit the entire header within this time, the connection is closed. 349 /// 350 /// Default is None. 351 #[cfg(all(feature = "http1", feature = "runtime"))] 352 #[cfg_attr(docsrs, doc(cfg(all(feature = "http1", feature = "runtime"))))] http1_header_read_timeout(mut self, read_timeout: Duration) -> Self353 pub fn http1_header_read_timeout(mut self, read_timeout: Duration) -> Self { 354 self.protocol.http1_header_read_timeout(read_timeout); 355 self 356 } 357 358 /// Sets whether HTTP/1 is required. 359 /// 360 /// Default is `false`. 361 #[cfg(feature = "http1")] 362 #[cfg_attr(docsrs, doc(cfg(feature = "http1")))] http1_only(mut self, val: bool) -> Self363 pub fn http1_only(mut self, val: bool) -> Self { 364 self.protocol.http1_only(val); 365 self 366 } 367 368 /// Sets whether HTTP/2 is required. 369 /// 370 /// Default is `false`. 371 #[cfg(feature = "http2")] 372 #[cfg_attr(docsrs, doc(cfg(feature = "http2")))] http2_only(mut self, val: bool) -> Self373 pub fn http2_only(mut self, val: bool) -> Self { 374 self.protocol.http2_only(val); 375 self 376 } 377 378 /// Configures the maximum number of pending reset streams allowed before a GOAWAY will be sent. 379 /// 380 /// This will default to whatever the default in h2 is. As of v0.3.17, it is 20. 381 /// 382 /// See <https://github.com/hyperium/hyper/issues/2877> for more information. 383 #[cfg(feature = "http2")] 384 #[cfg_attr(docsrs, doc(cfg(feature = "http2")))] http2_max_pending_accept_reset_streams(mut self, max: impl Into<Option<usize>>) -> Self385 pub fn http2_max_pending_accept_reset_streams(mut self, max: impl Into<Option<usize>>) -> Self { 386 self.protocol.http2_max_pending_accept_reset_streams(max); 387 self 388 } 389 390 /// Configures the maximum number of local reset streams allowed before a GOAWAY will be sent. 391 /// 392 /// If not set, hyper will use a default, currently of 1024. 393 /// 394 /// If `None` is supplied, hyper will not apply any limit. 395 /// This is not advised, as it can potentially expose servers to DOS vulnerabilities. 396 /// 397 /// See <https://rustsec.org/advisories/RUSTSEC-2024-0003.html> for more information. 398 #[cfg(feature = "http2")] 399 #[cfg_attr(docsrs, doc(cfg(feature = "http2")))] http2_max_local_error_reset_streams(mut self, max: impl Into<Option<usize>>) -> Self400 pub fn http2_max_local_error_reset_streams(mut self, max: impl Into<Option<usize>>) -> Self { 401 self.protocol.http2_max_local_error_reset_streams(max); 402 self 403 } 404 405 /// Sets the [`SETTINGS_INITIAL_WINDOW_SIZE`][spec] option for HTTP2 406 /// stream-level flow control. 407 /// 408 /// Passing `None` will do nothing. 409 /// 410 /// If not set, hyper will use a default. 411 /// 412 /// [spec]: https://http2.github.io/http2-spec/#SETTINGS_INITIAL_WINDOW_SIZE 413 #[cfg(feature = "http2")] 414 #[cfg_attr(docsrs, doc(cfg(feature = "http2")))] http2_initial_stream_window_size(mut self, sz: impl Into<Option<u32>>) -> Self415 pub fn http2_initial_stream_window_size(mut self, sz: impl Into<Option<u32>>) -> Self { 416 self.protocol.http2_initial_stream_window_size(sz.into()); 417 self 418 } 419 420 /// Sets the max connection-level flow control for HTTP2 421 /// 422 /// Passing `None` will do nothing. 423 /// 424 /// If not set, hyper will use a default. 425 #[cfg(feature = "http2")] 426 #[cfg_attr(docsrs, doc(cfg(feature = "http2")))] http2_initial_connection_window_size(mut self, sz: impl Into<Option<u32>>) -> Self427 pub fn http2_initial_connection_window_size(mut self, sz: impl Into<Option<u32>>) -> Self { 428 self.protocol 429 .http2_initial_connection_window_size(sz.into()); 430 self 431 } 432 433 /// Sets whether to use an adaptive flow control. 434 /// 435 /// Enabling this will override the limits set in 436 /// `http2_initial_stream_window_size` and 437 /// `http2_initial_connection_window_size`. 438 #[cfg(feature = "http2")] 439 #[cfg_attr(docsrs, doc(cfg(feature = "http2")))] http2_adaptive_window(mut self, enabled: bool) -> Self440 pub fn http2_adaptive_window(mut self, enabled: bool) -> Self { 441 self.protocol.http2_adaptive_window(enabled); 442 self 443 } 444 445 /// Sets the maximum frame size to use for HTTP2. 446 /// 447 /// Passing `None` will do nothing. 448 /// 449 /// If not set, hyper will use a default. 450 #[cfg(feature = "http2")] 451 #[cfg_attr(docsrs, doc(cfg(feature = "http2")))] http2_max_frame_size(mut self, sz: impl Into<Option<u32>>) -> Self452 pub fn http2_max_frame_size(mut self, sz: impl Into<Option<u32>>) -> Self { 453 self.protocol.http2_max_frame_size(sz); 454 self 455 } 456 457 /// Sets the max size of received header frames. 458 /// 459 /// Default is currently ~16MB, but may change. 460 #[cfg(feature = "http2")] 461 #[cfg_attr(docsrs, doc(cfg(feature = "http2")))] http2_max_header_list_size(mut self, max: u32) -> Self462 pub fn http2_max_header_list_size(mut self, max: u32) -> Self { 463 self.protocol.http2_max_header_list_size(max); 464 self 465 } 466 467 /// Sets the [`SETTINGS_MAX_CONCURRENT_STREAMS`][spec] option for HTTP2 468 /// connections. 469 /// 470 /// Default is no limit (`std::u32::MAX`). Passing `None` will do nothing. 471 /// 472 /// [spec]: https://http2.github.io/http2-spec/#SETTINGS_MAX_CONCURRENT_STREAMS 473 #[cfg(feature = "http2")] 474 #[cfg_attr(docsrs, doc(cfg(feature = "http2")))] http2_max_concurrent_streams(mut self, max: impl Into<Option<u32>>) -> Self475 pub fn http2_max_concurrent_streams(mut self, max: impl Into<Option<u32>>) -> Self { 476 self.protocol.http2_max_concurrent_streams(max.into()); 477 self 478 } 479 480 /// Sets an interval for HTTP2 Ping frames should be sent to keep a 481 /// connection alive. 482 /// 483 /// Pass `None` to disable HTTP2 keep-alive. 484 /// 485 /// Default is currently disabled. 486 /// 487 /// # Cargo Feature 488 /// 489 /// Requires the `runtime` cargo feature to be enabled. 490 #[cfg(all(feature = "runtime", feature = "http2"))] 491 #[cfg_attr(docsrs, doc(cfg(feature = "http2")))] http2_keep_alive_interval(mut self, interval: impl Into<Option<Duration>>) -> Self492 pub fn http2_keep_alive_interval(mut self, interval: impl Into<Option<Duration>>) -> Self { 493 self.protocol.http2_keep_alive_interval(interval); 494 self 495 } 496 497 /// Sets a timeout for receiving an acknowledgement of the keep-alive ping. 498 /// 499 /// If the ping is not acknowledged within the timeout, the connection will 500 /// be closed. Does nothing if `http2_keep_alive_interval` is disabled. 501 /// 502 /// Default is 20 seconds. 503 /// 504 /// # Cargo Feature 505 /// 506 /// Requires the `runtime` cargo feature to be enabled. 507 #[cfg(all(feature = "runtime", feature = "http2"))] 508 #[cfg_attr(docsrs, doc(cfg(feature = "http2")))] http2_keep_alive_timeout(mut self, timeout: Duration) -> Self509 pub fn http2_keep_alive_timeout(mut self, timeout: Duration) -> Self { 510 self.protocol.http2_keep_alive_timeout(timeout); 511 self 512 } 513 514 /// Set the maximum write buffer size for each HTTP/2 stream. 515 /// 516 /// Default is currently ~400KB, but may change. 517 /// 518 /// # Panics 519 /// 520 /// The value must be no larger than `u32::MAX`. 521 #[cfg(feature = "http2")] 522 #[cfg_attr(docsrs, doc(cfg(feature = "http2")))] http2_max_send_buf_size(mut self, max: usize) -> Self523 pub fn http2_max_send_buf_size(mut self, max: usize) -> Self { 524 self.protocol.http2_max_send_buf_size(max); 525 self 526 } 527 528 /// Enables the [extended CONNECT protocol]. 529 /// 530 /// [extended CONNECT protocol]: https://datatracker.ietf.org/doc/html/rfc8441#section-4 531 #[cfg(feature = "http2")] http2_enable_connect_protocol(mut self) -> Self532 pub fn http2_enable_connect_protocol(mut self) -> Self { 533 self.protocol.http2_enable_connect_protocol(); 534 self 535 } 536 537 /// Sets the `Executor` to deal with connection tasks. 538 /// 539 /// Default is `tokio::spawn`. executor<E2>(self, executor: E2) -> Builder<I, E2>540 pub fn executor<E2>(self, executor: E2) -> Builder<I, E2> { 541 Builder { 542 incoming: self.incoming, 543 protocol: self.protocol.with_executor(executor), 544 } 545 } 546 547 /// Consume this `Builder`, creating a [`Server`](Server). 548 /// 549 /// # Example 550 /// 551 /// ``` 552 /// # #[cfg(feature = "tcp")] 553 /// # async fn run() { 554 /// use hyper::{Body, Error, Response, Server}; 555 /// use hyper::service::{make_service_fn, service_fn}; 556 /// 557 /// // Construct our SocketAddr to listen on... 558 /// let addr = ([127, 0, 0, 1], 3000).into(); 559 /// 560 /// // And a MakeService to handle each connection... 561 /// let make_svc = make_service_fn(|_| async { 562 /// Ok::<_, Error>(service_fn(|_req| async { 563 /// Ok::<_, Error>(Response::new(Body::from("Hello World"))) 564 /// })) 565 /// }); 566 /// 567 /// // Then bind and serve... 568 /// let server = Server::bind(&addr) 569 /// .serve(make_svc); 570 /// 571 /// // Run forever-ish... 572 /// if let Err(err) = server.await { 573 /// eprintln!("server error: {}", err); 574 /// } 575 /// # } 576 /// ``` serve<S, B>(self, make_service: S) -> Server<I, S, E> 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>,577 pub fn serve<S, B>(self, make_service: S) -> Server<I, S, E> 578 where 579 I: Accept, 580 I::Error: Into<Box<dyn StdError + Send + Sync>>, 581 I::Conn: AsyncRead + AsyncWrite + Unpin + Send + 'static, 582 S: MakeServiceRef<I::Conn, Body, ResBody = B>, 583 S::Error: Into<Box<dyn StdError + Send + Sync>>, 584 B: HttpBody + 'static, 585 B::Error: Into<Box<dyn StdError + Send + Sync>>, 586 E: NewSvcExec<I::Conn, S::Future, S::Service, E, NoopWatcher>, 587 E: ConnStreamExec<<S::Service as HttpService<Body>>::Future, B>, 588 { 589 Server { 590 incoming: self.incoming, 591 make_service, 592 protocol: self.protocol.clone(), 593 } 594 } 595 } 596 597 #[cfg(feature = "tcp")] 598 #[cfg_attr( 599 docsrs, 600 doc(cfg(all(feature = "tcp", any(feature = "http1", feature = "http2")))) 601 )] 602 impl<E> Builder<AddrIncoming, E> { 603 /// Set the duration to remain idle before sending TCP keepalive probes. 604 /// 605 /// If `None` is specified, keepalive is disabled. tcp_keepalive(mut self, keepalive: Option<Duration>) -> Self606 pub fn tcp_keepalive(mut self, keepalive: Option<Duration>) -> Self { 607 self.incoming.set_keepalive(keepalive); 608 self 609 } 610 611 /// Set the duration between two successive TCP keepalive retransmissions, 612 /// if acknowledgement to the previous keepalive transmission is not received. tcp_keepalive_interval(mut self, interval: Option<Duration>) -> Self613 pub fn tcp_keepalive_interval(mut self, interval: Option<Duration>) -> Self { 614 self.incoming.set_keepalive_interval(interval); 615 self 616 } 617 618 /// Set the number of retransmissions to be carried out before declaring that remote end is not available. tcp_keepalive_retries(mut self, retries: Option<u32>) -> Self619 pub fn tcp_keepalive_retries(mut self, retries: Option<u32>) -> Self { 620 self.incoming.set_keepalive_retries(retries); 621 self 622 } 623 624 /// Set the value of `TCP_NODELAY` option for accepted connections. tcp_nodelay(mut self, enabled: bool) -> Self625 pub fn tcp_nodelay(mut self, enabled: bool) -> Self { 626 self.incoming.set_nodelay(enabled); 627 self 628 } 629 630 /// Set whether to sleep on accept errors. 631 /// 632 /// A possible scenario is that the process has hit the max open files 633 /// allowed, and so trying to accept a new connection will fail with 634 /// EMFILE. In some cases, it's preferable to just wait for some time, if 635 /// the application will likely close some files (or connections), and try 636 /// to accept the connection again. If this option is true, the error will 637 /// be logged at the error level, since it is still a big deal, and then 638 /// the listener will sleep for 1 second. 639 /// 640 /// In other cases, hitting the max open files should be treat similarly 641 /// to being out-of-memory, and simply error (and shutdown). Setting this 642 /// option to false will allow that. 643 /// 644 /// For more details see [`AddrIncoming::set_sleep_on_errors`] tcp_sleep_on_accept_errors(mut self, val: bool) -> Self645 pub fn tcp_sleep_on_accept_errors(mut self, val: bool) -> Self { 646 self.incoming.set_sleep_on_errors(val); 647 self 648 } 649 650 /// Returns the local address that the server will be bound to. 651 /// 652 /// This might be useful when knowing the address is required before calling `Builder::serve`, 653 /// but the address is not otherwise available (for e.g. when binding to port 0). local_addr(&self) -> SocketAddr654 pub fn local_addr(&self) -> SocketAddr { 655 self.incoming.local_addr() 656 } 657 } 658 659 // Used by `Server` to optionally watch a `Connection` future. 660 // 661 // The regular `hyper::Server` just uses a `NoopWatcher`, which does 662 // not need to watch anything, and so returns the `Connection` untouched. 663 // 664 // The `Server::with_graceful_shutdown` needs to keep track of all active 665 // connections, and signal that they start to shutdown when prompted, so 666 // it has a `GracefulWatcher` implementation to do that. 667 pub trait Watcher<I, S: HttpService<Body>, E>: Clone { 668 type Future: Future<Output = crate::Result<()>>; 669 watch(&self, conn: UpgradeableConnection<I, S, E>) -> Self::Future670 fn watch(&self, conn: UpgradeableConnection<I, S, E>) -> Self::Future; 671 } 672 673 #[allow(missing_debug_implementations)] 674 #[derive(Copy, Clone)] 675 pub struct NoopWatcher; 676 677 impl<I, S, E> Watcher<I, S, E> for NoopWatcher 678 where 679 I: AsyncRead + AsyncWrite + Unpin + Send + 'static, 680 S: HttpService<Body>, 681 E: ConnStreamExec<S::Future, S::ResBody>, 682 S::ResBody: 'static, 683 <S::ResBody as HttpBody>::Error: Into<Box<dyn StdError + Send + Sync>>, 684 { 685 type Future = UpgradeableConnection<I, S, E>; 686 watch(&self, conn: UpgradeableConnection<I, S, E>) -> Self::Future687 fn watch(&self, conn: UpgradeableConnection<I, S, E>) -> Self::Future { 688 conn 689 } 690 } 691 692 // used by exec.rs 693 pub(crate) mod new_svc { 694 use std::error::Error as StdError; 695 use std::future::Future; 696 use std::marker::Unpin; 697 use std::pin::Pin; 698 use std::task::{Context, Poll}; 699 700 use tokio::io::{AsyncRead, AsyncWrite}; 701 use tracing::debug; 702 703 use super::{Connecting, Watcher}; 704 use crate::body::{Body, HttpBody}; 705 use crate::common::exec::ConnStreamExec; 706 use crate::service::HttpService; 707 use pin_project_lite::pin_project; 708 709 // This is a `Future<Item=(), Error=()>` spawned to an `Executor` inside 710 // the `Server`. By being a nameable type, we can be generic over the 711 // user's `Service::Future`, and thus an `Executor` can execute it. 712 // 713 // Doing this allows for the server to conditionally require `Send` futures, 714 // depending on the `Executor` configured. 715 // 716 // Users cannot import this type, nor the associated `NewSvcExec`. Instead, 717 // a blanket implementation for `Executor<impl Future>` is sufficient. 718 719 pin_project! { 720 #[allow(missing_debug_implementations)] 721 pub struct NewSvcTask<I, N, S: HttpService<Body>, E, W: Watcher<I, S, E>> { 722 #[pin] 723 state: State<I, N, S, E, W>, 724 } 725 } 726 727 pin_project! { 728 #[project = StateProj] 729 pub(super) enum State<I, N, S: HttpService<Body>, E, W: Watcher<I, S, E>> { 730 Connecting { 731 #[pin] 732 connecting: Connecting<I, N, E>, 733 watcher: W, 734 }, 735 Connected { 736 #[pin] 737 future: W::Future, 738 }, 739 } 740 } 741 742 impl<I, N, S: HttpService<Body>, E, W: Watcher<I, S, E>> NewSvcTask<I, N, S, E, W> { new(connecting: Connecting<I, N, E>, watcher: W) -> Self743 pub(super) fn new(connecting: Connecting<I, N, E>, watcher: W) -> Self { 744 NewSvcTask { 745 state: State::Connecting { 746 connecting, 747 watcher, 748 }, 749 } 750 } 751 } 752 753 impl<I, N, S, NE, B, E, W> Future for NewSvcTask<I, N, S, E, W> 754 where 755 I: AsyncRead + AsyncWrite + Unpin + Send + 'static, 756 N: Future<Output = Result<S, NE>>, 757 NE: Into<Box<dyn StdError + Send + Sync>>, 758 S: HttpService<Body, ResBody = B>, 759 B: HttpBody + 'static, 760 B::Error: Into<Box<dyn StdError + Send + Sync>>, 761 E: ConnStreamExec<S::Future, B>, 762 W: Watcher<I, S, E>, 763 { 764 type Output = (); 765 poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>766 fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> { 767 // If it weren't for needing to name this type so the `Send` bounds 768 // could be projected to the `Serve` executor, this could just be 769 // an `async fn`, and much safer. Woe is me. 770 771 let mut me = self.project(); 772 loop { 773 let next = { 774 match me.state.as_mut().project() { 775 StateProj::Connecting { 776 connecting, 777 watcher, 778 } => { 779 let res = ready!(connecting.poll(cx)); 780 let conn = match res { 781 Ok(conn) => conn, 782 Err(err) => { 783 let err = crate::Error::new_user_make_service(err); 784 debug!("connecting error: {}", err); 785 return Poll::Ready(()); 786 } 787 }; 788 let future = watcher.watch(conn.with_upgrades()); 789 State::Connected { future } 790 } 791 StateProj::Connected { future } => { 792 return future.poll(cx).map(|res| { 793 if let Err(err) = res { 794 debug!("connection error: {}", err); 795 } 796 }); 797 } 798 } 799 }; 800 801 me.state.set(next); 802 } 803 } 804 } 805 } 806 807 pin_project! { 808 /// A future building a new `Service` to a `Connection`. 809 /// 810 /// Wraps the future returned from `MakeService` into one that returns 811 /// a `Connection`. 812 #[must_use = "futures do nothing unless polled"] 813 #[derive(Debug)] 814 #[cfg_attr(docsrs, doc(cfg(any(feature = "http1", feature = "http2"))))] 815 pub struct Connecting<I, F, E = Exec> { 816 #[pin] 817 future: F, 818 io: Option<I>, 819 protocol: Http_<E>, 820 } 821 } 822 823 impl<I, F, S, FE, E, B> Future for Connecting<I, F, E> 824 where 825 I: AsyncRead + AsyncWrite + Unpin, 826 F: Future<Output = Result<S, FE>>, 827 S: HttpService<Body, ResBody = B>, 828 B: HttpBody + 'static, 829 B::Error: Into<Box<dyn StdError + Send + Sync>>, 830 E: ConnStreamExec<S::Future, B>, 831 { 832 type Output = Result<Connection<I, S, E>, FE>; 833 poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>834 fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> { 835 let mut me = self.project(); 836 let service = ready!(me.future.poll(cx))?; 837 let io = Option::take(&mut me.io).expect("polled after complete"); 838 Poll::Ready(Ok(me.protocol.serve_connection(io, service))) 839 } 840 } 841