Struct actix_web::HttpServer [−][src]
pub struct HttpServer<F, I, S, B> where
F: Fn() -> I + Send + Clone + 'static,
I: IntoServiceFactory<S>,
S: ServiceFactory<Config = AppConfig, Request = Request>,
S::Error: Into<Error>,
S::InitError: Debug,
S::Response: Into<Response<B>>,
B: MessageBody, { /* fields omitted */ }
Expand description
An HTTP Server.
Create new http server with application factory.
use actix_web::{web, App, HttpResponse, HttpServer};
#[actix_rt::main]
async fn main() -> std::io::Result<()> {
HttpServer::new(
|| App::new()
.service(web::resource("/").to(|| HttpResponse::Ok())))
.bind("127.0.0.1:59090")?
.run()
.await
}
Implementations
impl<F, I, S, B> HttpServer<F, I, S, B> where
F: Fn() -> I + Send + Clone + 'static,
I: IntoServiceFactory<S>,
S: ServiceFactory<Config = AppConfig, Request = Request>,
S::Error: Into<Error> + 'static,
S::InitError: Debug,
S::Response: Into<Response<B>> + 'static,
<S::Service as Service>::Future: 'static,
B: MessageBody + 'static,
impl<F, I, S, B> HttpServer<F, I, S, B> where
F: Fn() -> I + Send + Clone + 'static,
I: IntoServiceFactory<S>,
S: ServiceFactory<Config = AppConfig, Request = Request>,
S::Error: Into<Error> + 'static,
S::InitError: Debug,
S::Response: Into<Response<B>> + 'static,
<S::Service as Service>::Future: 'static,
B: MessageBody + 'static,
pub fn on_connect<CB>(self, f: CB) -> HttpServer<F, I, S, B> where
CB: Fn(&dyn Any, &mut Extensions) + Send + Sync + 'static,
pub fn on_connect<CB>(self, f: CB) -> HttpServer<F, I, S, B> where
CB: Fn(&dyn Any, &mut Extensions) + Send + Sync + 'static,
Sets function that will be called once before each connection is handled.
It will receive a &std::any::Any
, which contains underlying connection type and an
Extensions container so that request-local data can be passed to middleware and handlers.
For example:
actix_tls::openssl::SslStream<actix_web::rt::net::TcpStream>
when using openssl.actix_tls::rustls::TlsStream<actix_web::rt::net::TcpStream>
when using rustls.actix_web::rt::net::TcpStream
when no encryption is used.
See on_connect
example for additional details.
Set number of workers to start.
By default http server uses number of available logical cpu as threads count.
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.
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.
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 TLS CPU usage.
By default max connections is set to a 256.
Set server keep-alive setting.
By default keep alive is set to a 5 seconds.
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.
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.
Set server host name.
Host name is used by application router as a hostname for url generation. Check ConnectionInfo documentation for more information.
By default host name is set to a “localhost” value.
Stop actix system.
Disable signal handling
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.
Get addresses of bound sockets.
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.
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.
Use listener for accepting incoming tls connection requests
This method sets alpn protocols to “h2” and “http/1.1”
Use listener for accepting incoming tls connection requests
This method sets alpn protocols to “h2” and “http/1.1”
The socket address to bind
To bind multiple addresses this method can be called multiple times.
pub fn bind_openssl<A>(
self,
addr: A,
builder: SslAcceptorBuilder
) -> Result<Self> where
A: ToSocketAddrs,
pub fn bind_openssl<A>(
self,
addr: A,
builder: SslAcceptorBuilder
) -> Result<Self> where
A: ToSocketAddrs,
Start listening for incoming tls connections.
This method sets alpn protocols to “h2” and “http/1.1”
pub fn bind_rustls<A: ToSocketAddrs>(
self,
addr: A,
config: RustlsServerConfig
) -> Result<Self>
pub fn bind_rustls<A: ToSocketAddrs>(
self,
addr: A,
config: RustlsServerConfig
) -> Result<Self>
Start listening for incoming tls connections.
This method sets alpn protocols to “h2” and “http/1.1”
Start listening for unix domain (UDS) connections on existing listener.
impl<F, I, S, B> HttpServer<F, I, S, B> where
F: Fn() -> I + Send + Clone + 'static,
I: IntoServiceFactory<S>,
S: ServiceFactory<Config = AppConfig, Request = Request>,
S::Error: Into<Error>,
S::InitError: Debug,
S::Response: Into<Response<B>>,
S::Service: 'static,
B: MessageBody,
impl<F, I, S, B> HttpServer<F, I, S, B> where
F: Fn() -> I + Send + Clone + 'static,
I: IntoServiceFactory<S>,
S: ServiceFactory<Config = AppConfig, Request = Request>,
S::Error: Into<Error>,
S::InitError: Debug,
S::Response: Into<Response<B>>,
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.
use std::io;
use actix_web::{web, App, HttpResponse, HttpServer};
#[actix_rt::main]
async fn main() -> io::Result<()> {
HttpServer::new(|| App::new().service(web::resource("/").to(|| HttpResponse::Ok())))
.bind("127.0.0.1:0")?
.run()
.await
}
Auto Trait Implementations
impl<F, I, S, B> !RefUnwindSafe for HttpServer<F, I, S, B>
impl<F, I, S, B> Send for HttpServer<F, I, S, B> where
B: Send,
S: Send,
impl<F, I, S, B> !Sync for HttpServer<F, I, S, B>
impl<F, I, S, B> Unpin for HttpServer<F, I, S, B> where
B: Unpin,
F: Unpin,
S: Unpin,
impl<F, I, S, B> !UnwindSafe for HttpServer<F, I, S, B>
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
pub fn vzip(self) -> V
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