Skip to main content

PerThreadShutdown

Struct PerThreadShutdown 

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

Shutdown coordinator shared by every worker spawned via spawn_per_thread (and friends). Workers select! against Self::notified in their accept loop, so triggering PerThreadShutdown::trigger cleanly exits each worker’s loop { accept } instead of leaking the OS thread on shutdown.

Backed by a tokio_util::sync::CancellationToken so the signal is sticky: workers that register notified() after trigger() was called still observe the request immediately, fixing the Notify::notify_waiters race where late subscribers would miss the shutdown.

Also carries a private [BindStatus] that workers update with the result of their SO_REUSEPORT bind so the parent (e.g. serve_per_thread) can fail loudly on “every worker failed to bind” instead of returning Ok(()) — previously the function would await Ctrl+C indefinitely and then claim success even when no listener was up, a false health signal to supervisors.

Implementations§

Source§

impl PerThreadShutdown

Source

pub fn new() -> Self

Construct an unsignalled shutdown coordinator.

Source

pub fn trigger(&self)

Notify every worker waiter that it should exit its accept loop. Idempotent — calling it more than once is a no-op.

Source

pub async fn notified(&self)

Future a worker awaits to learn that shutdown has been requested.

Source

pub async fn wait_for_bind_outcome(&self, total: usize) -> Result<()>

Wait until either at least one worker bound successfully, or all total workers reported a bind failure. Returns the first recorded io::Error in the all-failure case so the caller can propagate a real error instead of pretending the server started.

Trait Implementations§

Source§

impl Clone for PerThreadShutdown

Source§

fn clone(&self) -> PerThreadShutdown

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for PerThreadShutdown

Source§

fn default() -> PerThreadShutdown

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> 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§

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