3 stable releases

2.1.0 Dec 4, 2023
2.0.0 Apr 28, 2023
1.0.0 Apr 4, 2023

#253 in Unix APIs

Download history 497/week @ 2023-12-04 1084/week @ 2023-12-11 1643/week @ 2023-12-18 810/week @ 2023-12-25 1485/week @ 2024-01-01 3510/week @ 2024-01-08 2065/week @ 2024-01-15 1625/week @ 2024-01-22 1995/week @ 2024-01-29 2143/week @ 2024-02-05 2203/week @ 2024-02-12 1562/week @ 2024-02-19 2129/week @ 2024-02-26 2224/week @ 2024-03-04

8,190 downloads per month

BSD-3-Clause

38KB
658 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

~7–18MB
~220K SLoC