ShutdownCoordinator

Struct ShutdownCoordinator 

Source
pub struct ShutdownCoordinator { /* private fields */ }
Expand description

Shutdown coordinator

Manages graceful shutdown with grace period and timeout enforcement.

Implementations§

Source§

impl ShutdownCoordinator

Source

pub fn new(grace_period: Duration) -> Self

Create a new shutdown coordinator

§Arguments
  • grace_period - Maximum time to wait for graceful shutdown
Source

pub fn token(&self) -> CancellationToken

Get a cancellation token

Tokens can be cloned and passed to async tasks for shutdown signaling.

Source

pub fn is_shutting_down(&self) -> bool

Check if shutdown has been initiated

Source

pub fn initiate_shutdown(&self)

Initiate graceful shutdown

This will:

  1. Set shutdown initiated flag
  2. Cancel all tokens
  3. Start grace period timer
Source

pub async fn wait_for_shutdown(&self) -> bool

Wait for shutdown to complete or timeout

Returns true if shutdown completed within grace period, false if timeout occurred.

§Examples
use adaptive_pipeline_bootstrap::shutdown::ShutdownCoordinator;
use std::time::Duration;

let coordinator = ShutdownCoordinator::new(Duration::from_secs(5));

// In main application loop
coordinator.initiate_shutdown();

// Wait for all tasks to complete
if coordinator.wait_for_shutdown().await {
    println!("Shutdown completed gracefully");
} else {
    println!("Shutdown timed out, forcing exit");
}

coordinator.complete_shutdown();
Source

pub fn complete_shutdown(&self)

Signal that shutdown is complete

Call this after all cleanup is done to notify waiters.

Source

pub async fn wait_with_timeout(&self, timeout: Duration) -> bool

Wait for shutdown with custom timeout

Trait Implementations§

Source§

impl Clone for ShutdownCoordinator

Source§

fn clone(&self) -> ShutdownCoordinator

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for ShutdownCoordinator

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more