Skip to main content

EpochFencedReload

Struct EpochFencedReload 

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

Orchestrator for an atomic plugin reload — implements the proposal’s §11.2 epoch-fenced cutover.

The reload protocol:

  1. The host calls EpochFencedReload::begin_drain on the old plugin’s lifecycle. The state advances Active → Draining. New operations no longer capture the old plugin; in-flight ops that already captured an Arc<dyn ScalarPluginFn> continue against the old instance.
  2. The host invokes the load path for the new plugin and walks its lifecycle Loaded → Linked → Initialized → Active.
  3. The host calls EpochFencedReload::wait_for_drain, polling Arc::strong_count on the old plugin’s lifecycle. When the only outstanding reference is the framework’s bookkeeping Arc, every in-flight operation against the old plugin has completed.
  4. The host advances the old plugin’s lifecycle to Removed via EpochFencedReload::finalize.

The driver is decoupled from per-kind reload discipline (per proposal §11.2.1) — that lives in the host’s storage / index / background-job specific code. This driver provides the general state-machine orchestration.

EpochFencedReload is intentionally synchronous (no async fn) so it can be called from any context. For long-drain scenarios (e.g., 10s wall-clock queries against a storage backend), the host wraps the polling loop in its own async runtime.

Implementations§

Source§

impl EpochFencedReload

Source

pub fn new(old: Arc<PluginLifecycle>) -> Self

Construct a driver for an old-plugin lifecycle.

Source

pub fn begin_drain(&self) -> Result<(), DrainError>

Begin draining the old plugin. Advances state Active → Draining.

§Errors

Returns Err if the old plugin is not in Active state — the caller can choose to retry or bail out depending on policy.

Source

pub fn wait_for_drain( &self, threshold: usize, poll_interval: Duration, max_wait: Duration, ) -> Result<(), DrainError>

Wait until the old plugin has been fully drained.

Polls Arc::strong_count(&self.old) with the supplied poll interval. Returns when the count drops to threshold (the number of bookkeeping Arcs the framework holds), or Err(DrainError::Timeout) if max_wait elapses first.

threshold is typically 1 (just the framework’s own EpochFencedReload::old Arc); pass 2 if the host also keeps a side reference for diagnostics.

§Errors

Returns DrainError::Timeout if the strong-count doesn’t drop to threshold within max_wait.

Source

pub fn finalize(&self)

Finalize the drain — advance to Removed.

Typically called only after Self::wait_for_drain succeeds. Safe to call multiple times (idempotent at Removed).

Source

pub fn old_lifecycle(&self) -> &Arc<PluginLifecycle>

Shared access to the old plugin’s lifecycle (e.g., for observability hooks reading the current state).

Trait Implementations§

Source§

impl Debug for EpochFencedReload

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

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> PluginState for T
where T: Send + Sync + 'static,

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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