Struct Server

Source

pub struct Server { /* private fields */ }

Available on crate feature std only.

Expand description

A blocking HTTP/1.1 server: one thread per connection, bounded.

§Examples

use http_net::{blocking::{self, Server}, Response};

let server = Server::bind("127.0.0.1:0")?;
let addr = server.local_addr();
let stop = server.shutdown_handle();
let thread = std::thread::spawn(move || {
    server.serve(|req, _body| Response::text(200, &format!("you asked for {}", req.path())))
});

let resp = blocking::get(&format!("http://{addr}/hello"))?;
assert_eq!(resp.status(), 200);
assert_eq!(resp.text(), Some("you asked for /hello"));

stop.shutdown();
thread.join().unwrap()?;

Implementations§

Source §

impl Server

Source

pub fn bind(addr: impl ToSocketAddrs) -> Result<Self>

Binds a listening socket. Use 127.0.0.1:0 for an ephemeral localhost port and read it back with local_addr.

§Errors

The bind error from the operating system.

§Examples

let server = http_net::blocking::Server::bind("127.0.0.1:0")?;
assert!(server.local_addr().ip().is_loopback());

Source

pub fn with_config(self, config: ServerConfig) -> Self

Replaces the configuration.

§Examples

use http_net::blocking::{Server, ServerConfig};
let s = Server::bind("127.0.0.1:0")?.with_config(ServerConfig::new().with_max_connections(4));

Source

pub fn on_upgrade(self, hook: impl Fn(Upgraded) + Send + Sync + 'static) -> Self

Sets what happens to a connection after the handler answers with 101 Switching Protocols: hook receives the socket on the connection’s thread. Without a hook such connections are closed.

§Examples

See Upgraded.

Source

pub fn local_addr(&self) -> SocketAddr

The bound address (with the real port when bound to port 0).

§Examples

let server = http_net::blocking::Server::bind("127.0.0.1:0")?;
assert_ne!(server.local_addr().port(), 0);

Source

pub fn shutdown_handle(&self) -> ShutdownHandle

A handle that stops serve from another thread.

§Examples

See ShutdownHandle.

Source

pub fn serve<H>(self, handler: H) -> Result<()>
where H: Fn(&RequestHead<'_>, &[u8]) -> Response + Send + Sync + 'static,

Serves handler until ShutdownHandle::shutdown is called.

The handler gets each request’s head and its complete body (bounded by Limits::max_body) and returns the response. Requests that fail to parse are answered with their HttpError::status and the connection is closed; the handler never sees them. Every response gets a date header unless the handler set one.