#graceful-shutdown #process #signal #runnable #async-trait #async-stream #collect

processmanager

manage process lifecycles, graceful shutdown and process faults

1 unstable release

0.1.0 Mar 27, 2024

#818 in Rust patterns

Download history 117/week @ 2024-03-25 21/week @ 2024-04-01

138 downloads per month

MIT license

15KB
260 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(SignalReceiver::default());
    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

~4–15MB
~150K SLoC