use std::marker::PhantomData; use std::sync::Arc; use std::{fmt, io, net}; use actix_http::{body::MessageBody, h1, KeepAlive, Request, Response, ServiceConfig}; use actix_rt::System; use actix_server::{Server, ServerBuilder}; use actix_service::{IntoNewService, NewService}; use parking_lot::Mutex; use net2::TcpBuilder; #[cfg(feature = "tls")] use native_tls::TlsAcceptor; #[cfg(feature = "ssl")] use openssl::ssl::{SslAcceptor, SslAcceptorBuilder}; struct Socket { scheme: &'static str, addr: net::SocketAddr, } struct Config { keep_alive: KeepAlive, client_timeout: u64, client_shutdown: u64, } /// An HTTP Server. /// /// Create new http server with application factory. /// /// ```rust /// use std::io; /// use actix_web::{web, App, HttpResponse, HttpServer}; /// /// fn main() -> io::Result<()> { /// let sys = actix_rt::System::new("example"); // <- create Actix runtime /// /// HttpServer::new( /// || App::new() /// .service(web::resource("/").to(|| HttpResponse::Ok()))) /// .bind("127.0.0.1:59090")? /// .start(); /// /// # actix_rt::System::current().stop(); /// sys.run() /// } /// ``` pub struct HttpServer where F: Fn() -> I + Send + Clone + 'static, I: IntoNewService, S: NewService, S::Error: fmt::Debug, S::Response: Into>, S::Service: 'static, B: MessageBody, { pub(super) factory: F, pub(super) host: Option, config: Arc>, backlog: i32, sockets: Vec, builder: Option, _t: PhantomData<(S, B)>, } impl HttpServer where F: Fn() -> I + Send + Clone + 'static, I: IntoNewService, S: NewService, S::Error: fmt::Debug, S::Response: Into>, S::Service: 'static, B: MessageBody, { /// Create new http server with application factory pub fn new(factory: F) -> Self { HttpServer { factory, host: None, backlog: 2048, config: Arc::new(Mutex::new(Config { keep_alive: KeepAlive::Timeout(5), client_timeout: 5000, client_shutdown: 5000, })), sockets: Vec::new(), builder: Some(ServerBuilder::default()), _t: PhantomData, } } /// Set number of workers to start. /// /// By default http server uses number of available logical cpu as threads /// count. pub fn workers(mut self, num: usize) -> Self { self.builder = Some(self.builder.take().unwrap().workers(num)); self } /// Set the maximum number of pending connections. /// /// This refers to the number of clients that can be waiting to be served. /// Exceeding this number results in the client getting an error when /// attempting to connect. It should only affect servers under significant /// load. /// /// Generally set in the 64-2048 range. Default value is 2048. /// /// This method should be called before `bind()` method call. pub fn backlog(mut self, num: i32) -> Self { self.backlog = num; self } /// Sets the maximum per-worker number of concurrent connections. /// /// All socket listeners will stop accepting connections when this limit is reached /// for each worker. /// /// By default max connections is set to a 25k. pub fn maxconn(mut self, num: usize) -> Self { self.builder = Some(self.builder.take().unwrap().maxconn(num)); self } /// Sets the maximum per-worker concurrent connection establish process. /// /// All listeners will stop accepting connections when this limit is reached. It /// can be used to limit the global SSL CPU usage. /// /// By default max connections is set to a 256. pub fn maxconnrate(mut self, num: usize) -> Self { self.builder = Some(self.builder.take().unwrap().maxconnrate(num)); self } /// Set server keep-alive setting. /// /// By default keep alive is set to a 5 seconds. pub fn keep_alive>(self, val: T) -> Self { self.config.lock().keep_alive = val.into(); self } /// Set server client timeout in milliseconds for first request. /// /// Defines a timeout for reading client request header. If a client does not transmit /// the entire set headers within this time, the request is terminated with /// the 408 (Request Time-out) error. /// /// To disable timeout set value to 0. /// /// By default client timeout is set to 5000 milliseconds. pub fn client_timeout(self, val: u64) -> Self { self.config.lock().client_timeout = val; self } /// Set server connection shutdown timeout in milliseconds. /// /// Defines a timeout for shutdown connection. If a shutdown procedure does not complete /// within this time, the request is dropped. /// /// To disable timeout set value to 0. /// /// By default client timeout is set to 5000 milliseconds. pub fn client_shutdown(self, val: u64) -> Self { self.config.lock().client_shutdown = val; self } /// Set server host name. /// /// Host name is used by application router aa a hostname for url /// generation. Check [ConnectionInfo](./dev/struct.ConnectionInfo. /// html#method.host) documentation for more information. pub fn server_hostname(mut self, val: String) -> Self { self.host = Some(val); self } /// Stop actix system. pub fn system_exit(mut self) -> Self { self.builder = Some(self.builder.take().unwrap().system_exit()); self } /// Disable signal handling pub fn disable_signals(mut self) -> Self { self.builder = Some(self.builder.take().unwrap().disable_signals()); self } /// Timeout for graceful workers shutdown. /// /// After receiving a stop signal, workers have this much time to finish /// serving requests. Workers still alive after the timeout are force /// dropped. /// /// By default shutdown timeout sets to 30 seconds. pub fn shutdown_timeout(mut self, sec: u16) -> Self { self.builder = Some(self.builder.take().unwrap().shutdown_timeout(sec)); self } /// Get addresses of bound sockets. pub fn addrs(&self) -> Vec { self.sockets.iter().map(|s| s.addr).collect() } /// Get addresses of bound sockets and the scheme for it. /// /// This is useful when the server is bound from different sources /// with some sockets listening on http and some listening on https /// and the user should be presented with an enumeration of which /// socket requires which protocol. pub fn addrs_with_scheme(&self) -> Vec<(net::SocketAddr, &str)> { self.sockets.iter().map(|s| (s.addr, s.scheme)).collect() } /// Use listener for accepting incoming connection requests /// /// HttpServer does not change any configuration for TcpListener, /// it needs to be configured before passing it to listen() method. pub fn listen(mut self, lst: net::TcpListener) -> Self { let cfg = self.config.clone(); let factory = self.factory.clone(); let addr = lst.local_addr().unwrap(); self.sockets.push(Socket { addr, scheme: "http", }); self.builder = Some(self.builder.take().unwrap().listen( format!("actix-web-service-{}", addr), lst, move || { let c = cfg.lock(); let service_config = ServiceConfig::new(c.keep_alive, c.client_timeout, 0); h1::H1Service::with_config(service_config, factory()) }, )); self } #[cfg(feature = "tls")] /// Use listener for accepting incoming tls connection requests /// /// HttpServer does not change any configuration for TcpListener, /// it needs to be configured before passing it to listen() method. pub fn listen_tls(self, lst: net::TcpListener, acceptor: TlsAcceptor) -> Self { use actix_net::service::NewServiceExt; self.listen_with(lst, move || { ssl::NativeTlsAcceptor::new(acceptor.clone()).map_err(|_| ()) }) } #[cfg(feature = "ssl")] /// Use listener for accepting incoming tls connection requests /// /// This method sets alpn protocols to "h2" and "http/1.1" pub fn listen_ssl( mut self, lst: net::TcpListener, builder: SslAcceptorBuilder, ) -> io::Result { self.listen_ssl_inner(lst, openssl_acceptor(builder)?); Ok(self) } #[cfg(feature = "ssl")] fn listen_ssl_inner(&mut self, lst: net::TcpListener, acceptor: SslAcceptor) { use actix_server::ssl::{OpensslAcceptor, SslError}; let acceptor = OpensslAcceptor::new(acceptor); let factory = self.factory.clone(); let cfg = self.config.clone(); let addr = lst.local_addr().unwrap(); self.sockets.push(Socket { addr, scheme: "http", }); self.builder = Some(self.builder.take().unwrap().listen( format!("actix-web-service-{}", addr), lst, move || { let c = cfg.lock(); let service_config = ServiceConfig::new(c.keep_alive, c.client_timeout, c.client_timeout); acceptor.clone().map_err(|e| SslError::Ssl(e)).and_then( h1::H1Service::with_config(service_config, factory()) .map_err(|e| SslError::Service(e)) .map_init_err(|_| ()), ) }, )); } #[cfg(feature = "rust-tls")] /// Use listener for accepting incoming tls connection requests /// /// This method sets alpn protocols to "h2" and "http/1.1" pub fn listen_rustls(self, lst: net::TcpListener, config: ServerConfig) -> Self { use super::{RustlsAcceptor, ServerFlags}; use actix_net::service::NewServiceExt; self.listen_with(lst, move || { RustlsAcceptor::with_flags(config.clone(), flags).map_err(|_| ()) }) } /// The socket address to bind /// /// To bind multiple addresses this method can be called multiple times. pub fn bind(mut self, addr: A) -> io::Result { let sockets = self.bind2(addr)?; for lst in sockets { self = self.listen(lst); } Ok(self) } fn bind2( &self, addr: A, ) -> io::Result> { let mut err = None; let mut succ = false; let mut sockets = Vec::new(); for addr in addr.to_socket_addrs()? { match create_tcp_listener(addr, self.backlog) { Ok(lst) => { succ = true; sockets.push(lst); } Err(e) => err = Some(e), } } if !succ { if let Some(e) = err.take() { Err(e) } else { Err(io::Error::new( io::ErrorKind::Other, "Can not bind to address.", )) } } else { Ok(sockets) } } #[cfg(feature = "tls")] /// The ssl socket address to bind /// /// To bind multiple addresses this method can be called multiple times. pub fn bind_tls( self, addr: A, acceptor: TlsAcceptor, ) -> io::Result { use actix_net::service::NewServiceExt; use actix_net::ssl::NativeTlsAcceptor; self.bind_with(addr, move || { NativeTlsAcceptor::new(acceptor.clone()).map_err(|_| ()) }) } #[cfg(feature = "ssl")] /// Start listening for incoming tls connections. /// /// This method sets alpn protocols to "h2" and "http/1.1" pub fn bind_ssl( mut self, addr: A, builder: SslAcceptorBuilder, ) -> io::Result where A: net::ToSocketAddrs, { let sockets = self.bind2(addr)?; let acceptor = openssl_acceptor(builder)?; for lst in sockets { self.listen_ssl_inner(lst, acceptor.clone()); } Ok(self) } #[cfg(feature = "rust-tls")] /// Start listening for incoming tls connections. /// /// This method sets alpn protocols to "h2" and "http/1.1" pub fn bind_rustls( self, addr: A, builder: ServerConfig, ) -> io::Result { use super::{RustlsAcceptor, ServerFlags}; use actix_net::service::NewServiceExt; // alpn support let flags = if self.no_http2 { ServerFlags::HTTP1 } else { ServerFlags::HTTP1 | ServerFlags::HTTP2 }; self.bind_with(addr, move || { RustlsAcceptor::with_flags(builder.clone(), flags).map_err(|_| ()) }) } } impl HttpServer where F: Fn() -> I + Send + Clone + 'static, I: IntoNewService, S: NewService, S::Error: fmt::Debug, S::Response: Into>, S::Service: 'static, B: MessageBody, { /// Start listening for incoming connections. /// /// This method starts number of http workers in separate threads. /// For each address this method starts separate thread which does /// `accept()` in a loop. /// /// This methods panics if no socket address can be bound or an `Actix` system is not yet /// configured. /// /// ```rust /// use std::io; /// use actix_web::{web, App, HttpResponse, HttpServer}; /// /// fn main() -> io::Result<()> { /// let sys = actix_rt::System::new("example"); // <- create Actix system /// /// HttpServer::new(|| App::new().service(web::resource("/").to(|| HttpResponse::Ok()))) /// .bind("127.0.0.1:0")? /// .start(); /// # actix_rt::System::current().stop(); /// sys.run() // <- Run actix system, this method starts all async processes /// } /// ``` pub fn start(mut self) -> Server { self.builder.take().unwrap().start() } /// Spawn new thread and start listening for incoming connections. /// /// This method spawns new thread and starts new actix system. Other than /// that it is similar to `start()` method. This method blocks. /// /// This methods panics if no socket addresses get bound. /// /// ```rust /// use std::io; /// use actix_web::{web, App, HttpResponse, HttpServer}; /// /// fn main() -> io::Result<()> { /// # std::thread::spawn(|| { /// HttpServer::new(|| App::new().service(web::resource("/").to(|| HttpResponse::Ok()))) /// .bind("127.0.0.1:0")? /// .run() /// # }); /// # Ok(()) /// } /// ``` pub fn run(self) -> io::Result<()> { let sys = System::new("http-server"); self.start(); sys.run() } } fn create_tcp_listener( addr: net::SocketAddr, backlog: i32, ) -> io::Result { let builder = match addr { net::SocketAddr::V4(_) => TcpBuilder::new_v4()?, net::SocketAddr::V6(_) => TcpBuilder::new_v6()?, }; builder.reuse_address(true)?; builder.bind(addr)?; Ok(builder.listen(backlog)?) } #[cfg(feature = "ssl")] /// Configure `SslAcceptorBuilder` with custom server flags. fn openssl_acceptor(mut builder: SslAcceptorBuilder) -> io::Result { use openssl::ssl::AlpnError; builder.set_alpn_select_callback(|_, protos| { const H2: &[u8] = b"\x02h2"; if protos.windows(3).any(|window| window == H2) { Ok(b"h2") } else { Err(AlpnError::NOACK) } }); builder.set_alpn_protos(b"\x08http/1.1\x02h2")?; Ok(builder.build()) }