Struct SubsystemHandle 

pub struct SubsystemHandle {
    pub shutdown_tx: Sender<bool>,
    pub name: &'static str,
    /* private fields */
}

A running subsystem handle.

Dropping this handle sends the shutdown signal and detaches the task. Callers that want to wait for clean termination should call shutdown_and_wait with a deadline before dropping.

Fields

shutdown_tx: Sender<bool>

Sending true on this channel requests the subsystem to shut down.

name: &'static str

The name of the subsystem, for diagnostics.

Implementations

impl SubsystemHandle

pub fn new( name: &'static str, task: JoinHandle<()>, shutdown_tx: Sender<bool>, ) -> Self

Create a new handle from an already-spawned task and a shutdown signal.

pub async fn shutdown_and_wait( self, deadline: Instant, ) -> Result<(), ShutdownError>

Signal shutdown and wait for the task to finish, respecting deadline.

If the task does not finish by deadline, the task is aborted and ShutdownError::DeadlineExceeded is returned.

Trait Implementations

impl Drop for SubsystemHandle

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.