Skip to main content

PeerGovernor

Struct PeerGovernor 

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

Per-peer policy + health state owner.

Snapshot/restore: full state is captured in FrameworkSnapshot (work). Pre-Stage-5, restore rebuilds the governor from scratch - blocklist + allowlist settings on NodeConfig are re-applied at construction time.

Implementations§

Source§

impl PeerGovernor

Source

pub fn new() -> Self

Construct a fresh governor with no blocklist, no allowlist, and the default failure threshold.

Source

pub fn with_failure_threshold(self, threshold: u32) -> Self

Configure the failure threshold (consecutive failures before a peer is marked down). Default DEFAULT_FAILURE_THRESHOLD.

Source

pub fn block(&mut self, peer: PeerId)

Add a peer to the blocklist. Subsequent inbound envelopes from this peer are dropped; subsequent outbound sends fail.

Source

pub fn unblock(&mut self, peer: PeerId)

Remove a peer from the blocklist.

Source

pub fn set_allowlist(&mut self, allowlist: Option<HashSet<PeerId>>)

Set (or clear) the allowlist. When Some, only peers in the allowlist may communicate; everyone else is denied. None means “open” (default).

Source

pub fn peer_health(&self, peer: PeerId) -> Option<PeerHealth>

Per-peer health snapshot read; returns None if no success/failure has ever been recorded for peer.

Source

pub fn is_down(&self, peer: PeerId) -> bool

True when peer is currently marked down.

Source

pub fn check_inbound(&self, peer: PeerId) -> Decision

Inbound consultation - called from the engine’s Phase 1 envelope router before any slot is written.

Source

pub fn check_outbound( &self, peer: PeerId, backoff: &BackoffTable, now_ns: u64, ) -> Decision

Outbound consultation - called from the compiler-inserted PeerHealthGate syscall op upstream of every wire::Send. Returns Deny(Cooldown { retry_ns }) when the peer is in failure cooldown, prompting the gate to reschedule.

Source

pub fn record_success( &mut self, peer: PeerId, now_ns: u64, ) -> LifecycleTransition

Record a successful exchange with peer at now_ns. Resets the consecutive-failure counter; clears down. Returns the lifecycle transition the engine should surface as an EngineStep::PeerUp.

Source

pub fn record_failure( &mut self, peer: PeerId, now_ns: u64, ) -> LifecycleTransition

Record a failure for peer at now_ns. Returns WentDown when the failure pushes the streak across the threshold.

Source

pub fn tracked_peers(&self) -> usize

Number of distinct peers with health state recorded.

Source

pub fn blocklist(&self) -> &HashSet<PeerId>

Read-only view of the blocklist. Used by snapshot capture.

Source

pub fn allowlist(&self) -> Option<&HashSet<PeerId>>

Read-only view of the allowlist.

Source

pub fn iter_health(&self) -> impl Iterator<Item = (PeerId, PeerHealth)> + '_

Iterate (PeerId, PeerHealth) entries for snapshot capture.

Source

pub fn failure_threshold(&self) -> u32

Current failure threshold (consecutive failures to mark a peer down). Used by snapshot capture.

Source

pub fn restore_health(&mut self, peer: PeerId, health: PeerHealth)

Replace a peer’s health state directly. Used by Node::restore to re-seed health from a snapshot entry.

Source

pub fn set_failure_threshold(&mut self, threshold: u32)

Overwrite the failure threshold. Used by Node::restore.

Trait Implementations§

Source§

impl Default for PeerGovernor

Source§

fn default() -> Self

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<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> ErasedComponent for T
where T: Any + Send + Sync,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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, 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