Struct DrainHandle

Source

pub struct DrainHandle { /* private fields */ }

Expand description

Closes every WebSocket and SSE stream an endpoint holds.

The plugin drains automatically when the app shuts down (sockets close with 1001 Going Away, SSE streams end with complete), so clients reconnect to a healthy instance. Take a handle with GraphqlPlugin::drain_handle to drain earlier — for example when a readiness probe flips during a rolling deploy. Draining is permanent for the streams open at the time; new connections are still accepted.

DrainHandle

Struct DrainHandle Copy item path

Implementations§

impl DrainHandle

pub fn drain(&self)

Trait Implementations§

impl Clone for DrainHandle

fn clone(&self) -> Self

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

impl Debug for DrainHandle

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

Auto Trait Implementations§

impl !RefUnwindSafe for DrainHandle

impl !UnwindSafe for DrainHandle

impl Forget for DrainHandle

impl Freeze for DrainHandle

impl Send for DrainHandle

impl Sync for DrainHandle

impl Unpin for DrainHandle

impl UnsafeUnpin for DrainHandle

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DTwhere ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DTwhere ST: ?Sized, DT: ?Sized,

impl<T> CloneToUninit for Twhere T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FromRef<T> for Twhere T: Clone,

fn from_ref(input: &T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

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

fn into(self) -> U

impl<T> Read<Exclusive, BecauseExclusive> for Twhere T: ?Sized,

impl<T> Same for T

type Output = T

impl<T> Scoped for Twhere T: Send + Sync + 'static,

fn scope(ctx: &PolicyContext) -> ScopeQuery<'_, Self>

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = !

fn try_from(value: U) -> Result<T, !>

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

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

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

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Struct DrainHandle

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

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

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

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

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

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

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Scoped for T
where T: Send + Sync + 'static,

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

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

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

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