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

#154 in Unix APIs

Download history 4516/week @ 2024-11-15 4845/week @ 2024-11-22 4295/week @ 2024-11-29 4693/week @ 2024-12-06 3796/week @ 2024-12-13 1289/week @ 2024-12-20 1837/week @ 2024-12-27 4300/week @ 2025-01-03 3974/week @ 2025-01-10 4973/week @ 2025-01-17 5787/week @ 2025-01-24 5537/week @ 2025-01-31 5561/week @ 2025-02-07 5272/week @ 2025-02-14 5410/week @ 2025-02-21 6119/week @ 2025-02-28

23,481 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
~200K SLoC