Skip to main content

HttpProxy

Struct HttpProxy 

Source
pub struct HttpProxy<SV, C = ()>
where C: Connector,
{ pub server_options: Option<HttpServerOptions>, pub h2_options: Option<H2Options>, pub downstream_modules: HttpModules, /* private fields */ }
Expand description

The concrete type that holds the user defined HTTP proxy.

Users don’t need to interact with this object directly.

Fields§

§server_options: Option<HttpServerOptions>§h2_options: Option<H2Options>§downstream_modules: HttpModules

Implementations§

Source§

impl<SV> HttpProxy<SV, ()>

Source

pub fn new(inner: SV, conf: Arc<ServerConf>) -> Self

Create a new HttpProxy with the given ProxyHttp implementation and ServerConf.

After creating an HttpProxy, you should call HttpProxy::handle_init_modules() to initialize the downstream modules before processing requests.

For most use cases, prefer using http_proxy_service() which wraps the HttpProxy in a Service. This constructor is useful when you need to integrate HttpProxy into a custom accept loop (e.g., for SNI-based routing decisions before TLS termination).

§Example
use pingora_proxy::HttpProxy;
use std::sync::Arc;

let mut proxy = HttpProxy::new(my_proxy_app, server_conf);
proxy.handle_init_modules();
let proxy = Arc::new(proxy);
// Use proxy.process_new_http() in your custom accept loop
Source§

impl<SV, C> HttpProxy<SV, C>
where C: Connector,

Source

pub fn handle_init_modules(&mut self)
where SV: ProxyHttp,

Initialize the downstream modules for this proxy.

This method must be called after creating an HttpProxy with HttpProxy::new() and before processing any requests. It invokes ProxyHttp::init_downstream_modules() to set up any HTTP modules configured by the user’s proxy implementation.

Note: When using http_proxy_service() or http_proxy_service_with_name(), this method is called automatically.

Trait Implementations§

Source§

impl<SV, C> HttpServerApp for HttpProxy<SV, C>
where SV: ProxyHttp + Send + Sync + 'static, <SV as ProxyHttp>::CTX: Send + Sync, C: Connector,

Source§

fn process_new_http<'life0, 'life1, 'async_trait>( self: &'life0 Arc<Self>, session: HttpSession, shutdown: &'life1 ShutdownWatch, ) -> Pin<Box<dyn Future<Output = Option<ReusedHttpStream>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Similar to the ServerApp, this function is called whenever a new HTTP session is established. Read more
Source§

fn http_cleanup<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Source§

fn server_options(&self) -> Option<&HttpServerOptions>

Provide HTTP server options used to override default behavior. This function will be called every time a new connection is processed. Read more
Source§

fn h2_options(&self) -> Option<H2Options>

Provide options on how HTTP/2 connection should be established. This function will be called every time a new HTTP/2 connection needs to be established. Read more
Source§

impl<SV, C> Subrequest for HttpProxy<SV, C>
where SV: ProxyHttp + Send + Sync + 'static, <SV as ProxyHttp>::CTX: Send + Sync, C: Connector,

Source§

fn process_subrequest<'async_trait>( self: Arc<Self>, session: Box<HttpSession>, sub_req_ctx: Box<SubrequestCtx>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where Self: 'async_trait,

Auto Trait Implementations§

§

impl<SV, C = ()> !Freeze for HttpProxy<SV, C>

§

impl<SV, C = ()> !RefUnwindSafe for HttpProxy<SV, C>

§

impl<SV, C> Send for HttpProxy<SV, C>
where SV: Send,

§

impl<SV, C> Sync for HttpProxy<SV, C>
where SV: Sync,

§

impl<SV, C> Unpin for HttpProxy<SV, C>
where SV: Unpin,

§

impl<SV, C = ()> !UnwindSafe for HttpProxy<SV, C>

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

Source§

type Output = T

Should always be Self
Source§

impl<T> ServerApp for T
where T: HttpServerApp + Send + Sync + 'static,

Source§

fn process_new<'life0, 'life1, 'async_trait>( self: &'life0 Arc<T>, stream: Box<dyn IO>, shutdown: &'life1 Receiver<bool>, ) -> Pin<Box<dyn Future<Output = Option<Box<dyn IO>>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, T: 'async_trait,

Whenever a new connection is established, this function will be called with the established Stream object provided. Read more
Source§

fn cleanup<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where 'life0: 'async_trait, T: 'async_trait,

This callback will be called once after the service stops listening to its endpoints.
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