#file-descriptor #systemd #linux #pure #accept #api-bindings #helper

sd-listen-fds

Minimal, pure-rust helper to accept file descriptors from systemd

2 unstable releases

0.2.0 Aug 27, 2023
0.1.0 Jul 31, 2023

#1054 in Unix APIs

Download history 592/week @ 2024-11-22 832/week @ 2024-11-29 249/week @ 2024-12-06 159/week @ 2024-12-13 44/week @ 2024-12-20 9/week @ 2024-12-27 39/week @ 2025-01-03 62/week @ 2025-01-10 60/week @ 2025-01-17 71/week @ 2025-01-24 29/week @ 2025-01-31 33/week @ 2025-02-07 62/week @ 2025-02-14 64/week @ 2025-02-21 59/week @ 2025-02-28 31/week @ 2025-03-07

225 downloads per month

MIT/Apache

8KB
114 lines

sd-listen-fds

Documentation License: Apache 2.0 License: MIT

Exposes file descriptors passed in by systemd, the Linux init daemon, without dependencies, foreign or otherwise. Enables easy implementation of socket-activated services in pure Rust.

Unlike services that open sockets themselves, socket-activated services are started on-demand, may start up concurrently with their dependencies, and may be restarted without losing inbound data. Portable applications can call sd_listen_fds::get() and open their own socket if it succeeds with an empty Vec.

See also the sd_listen_fds API exposed by the foreign libsystemd library. Compared to using libsystemd bindings, this crate is smaller, safer, and builds everywhere.

Example

let fds = sd_listen_fds::get().unwrap();
let (_name, fd) = fds
    .into_iter()
    .next()
    .expect("must be launched as a systemd socket-activated service");
let socket = TcpListener::from(fd);

my-service.socket (see also systemd.socket)

[Socket]
# TCP port number. Other types of sockets are also possible.
ListenStream=1234

[Install]
WantedBy=sockets.target

[Unit]
Description=My Rust service
Documentation=https://example.com/my-service/

my-service.service (see also systemd.service)

[Service]
ExecStart=/path/to/my-service

[Unit]
Requires=my-service.socket
Description=My Rust service
Documentation=https://example.com/my-service/

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

No runtime deps