3 stable releases

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

#202 in Unix APIs

Download history 1599/week @ 2024-01-21 2001/week @ 2024-01-28 2107/week @ 2024-02-04 2212/week @ 2024-02-11 1605/week @ 2024-02-18 2129/week @ 2024-02-25 2214/week @ 2024-03-03 2690/week @ 2024-03-10 2617/week @ 2024-03-17 2157/week @ 2024-03-24 2338/week @ 2024-03-31 1861/week @ 2024-04-07 1851/week @ 2024-04-14 2172/week @ 2024-04-21 2305/week @ 2024-04-28 1524/week @ 2024-05-05

7,881 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

~6–19MB
~213K SLoC