Skip to main content

GatewayRingPolicy

Struct GatewayRingPolicy 

Source
pub struct GatewayRingPolicy {
    pub failure_threshold: u32,
    pub cooldown: Option<Duration>,
}
Expand description

What RuntimeBuilder::with_gateway_ring and its two companions take and report, under the same rule as the provider-authoring types above: the builder makes a host name these, so basis re-exports them. The ring itself stays in mentra (ADR-0027); GatewayMember is basis’s own, because it carries a URL the way RuntimeBuilder::with_base_url takes one. How a ring decides when to leave a member and when to come back.

Fields§

§failure_threshold: u32

Consecutive counted failures on the active member before the ring rotates away from it.

Counted across calls, not within one: a member that fails, is retried by the runtime’s own backoff, and fails again has a streak of two. For the rotation to happen inside a single turn this should be no larger than the runtime’s retry budget; a larger threshold still rotates, just across turns. 0 is read as 1.

§cooldown: Option<Duration>

How long a member the ring rotated away from rests before a more preferred one is tried again.

Some makes the ring drift back: once the preferred member has rested this long, the next call probes it, and one failure sends the ring back to where it was. None makes the ring sticky: it stays on whichever member last worked, and only reaches an earlier one by rotating all the way around.

Implementations§

Source§

impl GatewayRingPolicy

Source

pub const DEFAULT_FAILURE_THRESHOLD: u32 = 5

Five consecutive failures, then rotate; drift back to the preferred member after it has rested a minute.

Source

pub const DEFAULT_COOLDOWN: Duration

Source

pub const fn sticky() -> GatewayRingPolicy

A sticky ring: rotate on the default threshold and never drift back.

Source

pub const fn with_failure_threshold( self, failure_threshold: u32, ) -> GatewayRingPolicy

The same policy with a different failure threshold.

Source

pub const fn with_cooldown( self, cooldown: Option<Duration>, ) -> GatewayRingPolicy

The same policy with a different cooldown, or none.

Trait Implementations§

Source§

impl Clone for GatewayRingPolicy

Source§

fn clone(&self) -> GatewayRingPolicy

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 Copy for GatewayRingPolicy

Source§

impl Debug for GatewayRingPolicy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for GatewayRingPolicy

Source§

fn default() -> GatewayRingPolicy

Returns the “default value” for a type. Read more
Source§

impl Eq for GatewayRingPolicy

Source§

impl PartialEq for GatewayRingPolicy

Source§

fn eq(&self, other: &GatewayRingPolicy) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for GatewayRingPolicy

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> 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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> 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 = !

The type returned in the event of a conversion error.
Source§

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

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