Struct UpstreamHandler

pub struct UpstreamHandler { /* private fields */ }

Handler for Pingora’s request_filter phase

Implementations

impl UpstreamHandler

pub async fn upstream_peer( _session: &mut Session, ctx: &mut Option<UpstreamContext>, ) -> Result<Box<HttpPeer>, Box<Error>>

This function should be called during the upstream_peer phase of Pingora Proxy to produce the upstream peer which was determined in the request_filter phase. Will return a 404 Not Found error if no upstream is configured.

Trait Implementations

impl Debug for UpstreamHandler

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

Formats the value using the given formatter.

impl RequestFilter for UpstreamHandler

type Conf = UpstreamConf

Configuration type of this handler.

type CTX = Option<UpstreamContext>

Per-request state of this handler, see pingora_proxy::ProxyHttp::CTX

fn new_ctx() -> Self::CTX

Creates a new sate object, see pingora_proxy::ProxyHttp::new_ctx

fn request_filter<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, session: &'life1 mut Session, ctx: &'life2 mut Self::CTX, ) -> Pin<Box<dyn Future<Output = Result<RequestFilterResult, Box<Error>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Handler to run during Pingora’s request_filter state, see pingora_proxy::ProxyHttp::request_filter. This uses a different return type to account for the existence of multiple request filters.

fn new(conf: Self::Conf) -> Result<Self, Box<Error>>

where Self: Sized, Self::Conf: TryInto<Self, Error = Box<Error>>,

Creates a new instance of the handler from its configuration.

fn handle<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, session: &'life1 mut Session, ctx: &'life2 mut Self::CTX, ) -> Pin<Box<dyn Future<Output = Result<bool, Box<Error>>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self::CTX: Send, Self: Sync + 'async_trait,

Handles the current request.

impl TryFrom<UpstreamConf> for UpstreamHandler

type Error = Box<Error>

The type returned in the event of a conversion error.

fn try_from(conf: UpstreamConf) -> Result<Self, Self::Error>

Performs the conversion.