Struct ShutdownController 

pub struct ShutdownController { /* private fields */ }

Controller for coordinated graceful shutdown.

This provides a clean way to propagate shutdown signals through an application. Multiple receivers can subscribe to receive shutdown notifications.

Example

use asupersync::signal::ShutdownController;

async fn run_server() {
    let controller = ShutdownController::new();
    let mut receiver = controller.subscribe();

    // Spawn a task that will receive the shutdown signal
    let handle = async move {
        receiver.wait().await;
        println!("Shutting down...");
    };

    // Later, initiate shutdown
    controller.shutdown();
}

Implementations

impl ShutdownController

pub fn new() -> ShutdownController

Creates a new shutdown controller.

pub fn subscribe(&self) -> ShutdownReceiver

Gets a handle for receiving shutdown notifications.

Multiple receivers can be created and they will all be notified when shutdown is initiated.

pub fn shutdown(&self)

Initiates shutdown.

This wakes all receivers that are currently waiting for shutdown. The shutdown state is persistent - once initiated, it cannot be reset.

pub fn is_shutting_down(&self) -> bool

Checks if shutdown has been initiated.

pub fn listen_for_signals(self: &Arc<ShutdownController>)

Spawns a background task to listen for shutdown signals.

This is a convenience method that sets up signal handling (when available) to automatically trigger shutdown.

Note

In Phase 0, signal handling is not available, so this method only sets up the controller for manual shutdown calls.

Trait Implementations

impl Clone for ShutdownController

fn clone(&self) -> ShutdownController

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ShutdownController

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for ShutdownController

fn default() -> ShutdownController

Returns the “default value” for a type.