#graceful-shutdown #process #signal #runnable #async-trait #tokio #fault

processmanager

manage process lifecycles, graceful shutdown and process faults

7 releases

0.3.2 Nov 10, 2024
0.3.1 Nov 6, 2024
0.3.0 Sep 16, 2024
0.2.2 Nov 6, 2024
0.1.0 Mar 27, 2024

#605 in Rust patterns

Download history 12/week @ 2024-10-01 7/week @ 2024-10-08 44/week @ 2024-10-15 44/week @ 2024-10-22 16/week @ 2024-10-29 393/week @ 2024-11-05 22/week @ 2024-11-12 13/week @ 2024-11-19 2/week @ 2024-11-26 58/week @ 2024-12-03 67/week @ 2024-12-10 33/week @ 2024-12-17

619 downloads per month

MIT license

21KB
375 lines

ProcessManager

Manage multiple running services. A ProcessManager collects impl of Runnable and takes over the runtime management like starting, stopping (graceful or in failure) of services.

If one service fails, the manager initiates a graceful shutdown for all other.

Examples

use processmanager::*;

#[tokio::main]
async fn main() {

    #[derive(Default)]
    struct ExampleController {
        runtime_guard: RuntimeGuard,
    }

    #[async_trait::async_trait]
    impl Runnable for ExampleController {
        async fn process_start(&self) -> Result<(), RuntimeError> {
            // This can be any type of future like an async streams
            let mut interval = tokio::time::interval(tokio::time::Duration::from_secs(1));

            loop {
                match self.runtime_guard.tick(interval.tick()).await {
                    ProcessOperation::Next(_) => println!("work"),
                    ProcessOperation::Control(RuntimeControlMessage::Shutdown) => {
                        println!("shutdown"); 
                        break
                    },
                    ProcessOperation::Control(RuntimeControlMessage::Reload) => println!("trigger relead"),
                }
            }

            Ok(())
        }

        fn process_handle(&self) -> Box<dyn ProcessControlHandler> {
            Box::new(self.runtime_guard.handle())
         }
    }

    let mut manager = ProcessManager::new();
    manager.insert(ExampleController::default());

    let handle = manager.process_handle();

    // start all processes
    let _ = tokio::spawn(async move {
        manager.process_start().await.expect("service start failed");
    });

    // Shutdown waits for all services to shutdown gracefully.
    handle.shutdown().await;
}

Dependencies

~3–12MB
~119K SLoC