Struct uiuifree_actix_web_util::HttpServer

pub struct HttpServer<F, I, S, B> where
    F: 'static + Fn() -> I + Send + Clone,
    I: IntoServiceFactory<S, Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>>,
    S: ServiceFactory<Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>, Config = AppConfig>,
    B: MessageBody,
    <S as ServiceFactory<Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>>>::Error: Into<Error>,
    <S as ServiceFactory<Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>>>::InitError: Debug,
    <S as ServiceFactory<Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>>>::Response: Into<Response<B>>, { /* private fields */ }

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: 'static + Fn() -> I + Send + Clone,
    I: IntoServiceFactory<S, Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>>,
    S: 'static + ServiceFactory<Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>, Config = AppConfig>,
    B: 'static + MessageBody,
    <S as ServiceFactory<Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>>>::Error: 'static,
    <S as ServiceFactory<Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>>>::Error: Into<Error>,
    <S as ServiceFactory<Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>>>::InitError: Debug,
    <S as ServiceFactory<Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>>>::Response: 'static,
    <S as ServiceFactory<Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>>>::Response: Into<Response<B>>,
    <<S as ServiceFactory<Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>>>::Service as Service<Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>>>::Future: 'static,
    <S as ServiceFactory<Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>>>::Service: 'static, 

pub fn new(factory: F) -> HttpServer<F, I, S, B>

Create new HTTP server with application factory

pub fn on_connect<CB>(self, f: CB) -> HttpServer<F, I, S, B> where
    CB: 'static + Fn(&(dyn Any + 'static), &mut Extensions) + Send + Sync, 

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 connection data can be accessed in middleware and handlers.

Connection Types

• actix_tls::accept::openssl::TlsStream<actix_web::rt::net::TcpStream> when using openssl.
• actix_tls::accept::rustls::TlsStream<actix_web::rt::net::TcpStream> when using rustls.
• actix_web::rt::net::TcpStream when no encryption is used.

See the on_connect example for additional details.

pub fn workers(self, num: usize) -> HttpServer<F, I, S, B>

Set number of workers to start.

By default, the number of available physical CPUs is used as the worker count.

pub fn backlog(self, backlog: u32) -> HttpServer<F, I, S, B>

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 max_connections(self, num: usize) -> HttpServer<F, I, S, B>

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 max_connection_rate(self, num: usize) -> HttpServer<F, I, S, B>

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.

pub fn worker_max_blocking_threads(self, num: usize) -> HttpServer<F, I, S, B>

Set max number of threads for each worker’s blocking task thread pool.

One thread pool is set up per worker; not shared across workers.

By default set to 512 / workers.

pub fn keep_alive<T>(self, val: T) -> HttpServer<F, I, S, B> where
    T: Into<KeepAlive>, 

Set server keep-alive setting.

By default keep alive is set to a 5 seconds.

pub fn client_request_timeout(self, dur: Duration) -> HttpServer<F, I, S, B>

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_disconnect_timeout(self, dur: Duration) -> HttpServer<F, I, S, B>

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 server_hostname<T>(self, val: T) -> HttpServer<F, I, S, B> where
    T: AsRef<str>, 

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.

pub fn system_exit(self) -> HttpServer<F, I, S, B>

Stop Actix System after server shutdown.

pub fn disable_signals(self) -> HttpServer<F, I, S, B>

Disable signal handling

pub fn shutdown_timeout(self, sec: u64) -> HttpServer<F, I, S, B>

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 addrs(&self) -> Vec<SocketAddr, Global>

Get addresses of bound sockets.

pub fn addrs_with_scheme(&self) -> Vec<(SocketAddr, &str), Global>

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 listen(self, lst: TcpListener) -> Result<HttpServer<F, I, S, B>, Error>

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 bind<A>(self, addr: A) -> Result<HttpServer<F, I, S, B>, Error> where
    A: ToSocketAddrs, 

The socket address to bind

To bind multiple addresses this method can be called multiple times.

pub fn listen_uds(
    self,
    lst: UnixListener
) -> Result<HttpServer<F, I, S, B>, Error>

Start listening for unix domain (UDS) connections on existing listener.

pub fn bind_uds<A>(self, addr: A) -> Result<HttpServer<F, I, S, B>, Error> where
    A: AsRef<Path>, 

Start listening for incoming unix domain connections.

impl<F, I, S, B> HttpServer<F, I, S, B> where
    F: 'static + Fn() -> I + Send + Clone,
    I: IntoServiceFactory<S, Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>>,
    S: ServiceFactory<Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>, Config = AppConfig>,
    B: MessageBody,
    <S as ServiceFactory<Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>>>::Error: Into<Error>,
    <S as ServiceFactory<Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>>>::InitError: Debug,
    <S as ServiceFactory<Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>>>::Response: Into<Response<B>>,
    <S as ServiceFactory<Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>>>::Service: 'static, 

pub fn run(self) -> Server

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
}