4 stable releases

2.1.1 Oct 9, 2024
2.1.0 Dec 4, 2023
2.0.0 Apr 28, 2023
1.0.0 Apr 4, 2023

#160 in Unix APIs

Download history 3747/week @ 2024-10-23 3758/week @ 2024-10-30 4036/week @ 2024-11-06 4110/week @ 2024-11-13 4741/week @ 2024-11-20 4764/week @ 2024-11-27 4754/week @ 2024-12-04 3915/week @ 2024-12-11 2665/week @ 2024-12-18 1104/week @ 2024-12-25 3648/week @ 2025-01-01 4002/week @ 2025-01-08 4057/week @ 2025-01-15 5790/week @ 2025-01-22 5759/week @ 2025-01-29 4767/week @ 2025-02-05

21,042 downloads per month

BSD-3-Clause

38KB
660 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
~201K SLoC