Struct ShutdownNotifier

Source

pub struct ShutdownNotifier {
    pub notify_shutdown: Sender<()>,
    pub shutdown_complete_rx: Receiver<()>,
    pub shutdown_complete_tx: Sender<()>,
}

Fields§

§notify_shutdown: Sender<()>

Broadcasts a shutdown signal to all related components.

§shutdown_complete_rx: Receiver<()>

Used as part of the graceful shutdown process to wait for related components to complete processing.

Tokio channels are closed once all Sender handles go out of scope. When a channel is closed, the receiver receives None. This is leveraged to detect all shutdown processing completing.

§shutdown_complete_tx: Sender<()>

Implementations§

Source §

impl ShutdownNotifier

Source

pub fn new() -> Self

Create a new ShutdownNotifier instance

Source

pub fn subscribe_for_shutdown(&self) -> Shutdown

Subscribe for shutdown notification

Trait Implementations§

Source §

impl Default for ShutdownNotifier

Source §

fn default() -> Self

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

Auto Trait Implementations§

§

impl !UnwindSafe for ShutdownNotifier

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> 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 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §