5 stable releases

2.1.2 Mar 24, 2025
2.1.1 Oct 9, 2024
2.1.0 Dec 4, 2023
2.0.0 Apr 28, 2023
1.0.0 Apr 4, 2023

#177 in Unix APIs

Download history 1009/week @ 2024-12-21 2235/week @ 2024-12-28 4373/week @ 2025-01-04 4188/week @ 2025-01-11 4975/week @ 2025-01-18 5751/week @ 2025-01-25 5660/week @ 2025-02-01 5516/week @ 2025-02-08 5318/week @ 2025-02-15 5470/week @ 2025-02-22 6364/week @ 2025-03-01 8130/week @ 2025-03-08 6630/week @ 2025-03-15 6385/week @ 2025-03-22 8578/week @ 2025-03-29 8321/week @ 2025-04-05

31,100 downloads per month

BSD-3-Clause

38KB
661 lines

shellflip

crates.io docs.rs

Graceful process restarts in Rust.

This crate facilitates upgrading or reconfiguring a service without disrupting existing connections. This is achieved by forking the process and communicating a small amount of state between the old and new processes; once the new process has started successfully the old process may terminate.

This crate has the following goals:

  • No old code keeps running after a successful upgrade (and inevitable shutdown of the old process)
  • The new process has a grace period for performing initialisation
  • Crashing during initialisation is OK
  • Only a single upgrade is ever run in parallel
  • It is possible for the user/process initiating the upgrade to know if the upgrade succeeded

Inspired by the tableflip go package but not a direct replacement.

Using the library

A full example is given in the restarter example service.

The main struct of interest is RestartConfig which has methods for detecting or initiating restart. For shutting down a restarted process, the ShutdownCoordinator provides the means for both signalling a shutdown event to spawned tasks, and awaiting their completion.

License

BSD licensed. See the LICENSE file for details.

🦀ノ( º _ ºノ) - respect crables!

Dependencies

~6–16MB
~202K SLoC