Skip to main content

AdaptiveEndpoint

Struct AdaptiveEndpoint 

Source
pub struct AdaptiveEndpoint<S> { /* private fields */ }
Expand description

A Tower service with per-endpoint adaptive pacing and bounded admission.

poll_ready reports whether another request can enter the endpoint’s bounded scheduling horizon. call reserves a virtual GCRA slot; the returned future waits until that slot is due, waits for the inner service to be ready, and only then records the actual dispatch. Queue delay therefore never contaminates the RTT sample.

The endpoint is intentionally single-owner: Tower’s P2C balancer owns one service per discovered backend and does not require endpoint services to be cloneable. This lets readiness use the controller’s queue state directly, without a second shared allocation for coordinating cloned handles.

Implementations§

Source§

impl<S> AdaptiveEndpoint<S>

Source

pub fn new(inner: S, config: EndpointConfig) -> Self

Wraps a Tower endpoint using the current Tokio runtime time.

The returned service starts with an immediately available pacing slot.

§Panics

Panics when config contains invalid controller settings.

Source

pub fn new_at(inner: S, config: EndpointConfig, now: Instant) -> Self

Wraps a Tower endpoint using an explicit controller start time.

This constructor is useful in deterministic tests. Production code should normally use Self::new so Tokio and controller deadlines share the runtime’s clock domain.

§Panics

Panics when config contains invalid controller settings.

Source

pub fn snapshot(&self) -> ControllerSnapshot

Returns a current snapshot of this endpoint’s controller.

Reading a snapshot refreshes time-driven probe state and may update the effective pacing rate.

Source

pub fn load_metric(&self) -> LoadMetric

Returns the endpoint’s predicted completion cost for load balancing.

Lower values are preferred. Reading the metric refreshes time-driven controller state, including probes.

Trait Implementations§

Source§

impl<S> Load for AdaptiveEndpoint<S>

Source§

type Metric = LoadMetric

A comparable load metric. Read more
Source§

fn load(&self) -> Self::Metric

Estimate the service’s current load.
Source§

impl<S, Request> Service<Request> for AdaptiveEndpoint<S>
where S: Service<Request> + Send + 'static, S::Future: Send + 'static, Request: Send + 'static,

Source§

type Response = <S as Service<Request>>::Response

Responses given by the service.
Source§

type Error = <S as Service<Request>>::Error

Errors produced by the service.
Source§

type Future = ResponseFuture<<S as Service<Request>>::Response, <S as Service<Request>>::Error>

The future response value.
Source§

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests. Read more
Source§

fn call(&mut self, request: Request) -> Self::Future

Process the request and return the response asynchronously. Read more

Auto Trait Implementations§

§

impl<S> !RefUnwindSafe for AdaptiveEndpoint<S>

§

impl<S> !UnwindSafe for AdaptiveEndpoint<S>

§

impl<S> Freeze for AdaptiveEndpoint<S>
where Arc<Shared<S>>: Freeze,

§

impl<S> Send for AdaptiveEndpoint<S>
where Arc<Shared<S>>: Send,

§

impl<S> Sync for AdaptiveEndpoint<S>
where Arc<Shared<S>>: Sync,

§

impl<S> Unpin for AdaptiveEndpoint<S>
where Arc<Shared<S>>: Unpin,

§

impl<S> UnsafeUnpin for AdaptiveEndpoint<S>
where Arc<Shared<S>>: UnsafeUnpin,

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