listenfd

Crates.iolistenfd
lib.rslistenfd
version1.0.1
sourcesrc
created_at2018-05-17 00:48:16.906123
updated_at2023-03-10 12:45:07.880871
descriptionA simple library to work with listenfds passed from the outside (systemd/catflap socket activation)
homepagehttps://github.com/mitsuhiko/rust-listenfd
repository
max_upload_size
id65800
size59,429
Armin Ronacher (mitsuhiko)

documentation

README

listenfd

Build Status Crates.io License rustc 1.42.0 Documentation

listenfd is a crate that provides support for working with externally managed and passed file descriptors. This lets you work with systems that support socket activation or similar.

Currently this supports systemd on Unix and systemfd on Unix and Windows. systemfd is very convenient in combination with cargo-watch for development purposes whereas systemd is useful for production deployments on linux.

Example

use listenfd::ListenFd;

let mut listenfd = ListenFd::from_env();
let mut server = make_a_server();

// if we are given a tcp listener on listen fd 0, we use that one
server = if let Some(listener) = listenfd.take_tcp_listener(0)? {
    server.listen(listener)
// otherwise fall back to local listening
} else {
    server.bind("127.0.0.1:3000")?
};

You can then use this with cargo watch and systemfd:

$ cargo install systemfd cargo-watch
systemfd --no-pid -s http::3000 -- cargo watch -x run

Now systemfd will open the socket and keep it open. cargo watch will recompile the code on demand and the server will pick up the socket that systemfd opened. No more connection resets.

License and Links

Commit count: 0

cargo fmt