Skip to main content

ProxyServiceBuilder

Struct ProxyServiceBuilder 

Source
pub struct ProxyServiceBuilder<SV, C>
where SV: ProxyHttp + Send + Sync + 'static, SV::CTX: Send + Sync + 'static, C: Connector,
{ /* private fields */ }
Expand description

A builder for a Service that can be used to create a HttpProxy instance

The ProxyServiceBuilder can be used to construct a HttpProxy service with a custom name, connector, and custom session handler.

Implementations§

Source§

impl<SV> ProxyServiceBuilder<SV, ()>
where SV: ProxyHttp + Send + Sync + 'static, SV::CTX: Send + Sync + 'static,

Source

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

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

The returned builder can be used to construct a HttpProxy service with a custom name, connector, and custom session handler.

The ProxyServiceBuilder will default to using the ProxyHttp implementation and no custom session handler.

Source§

impl<SV, C> ProxyServiceBuilder<SV, C>
where SV: ProxyHttp + Send + Sync + 'static, SV::CTX: Send + Sync + 'static, C: Connector,

Source

pub fn name(self, name: impl AsRef<str>) -> Self

Sets the name of the HttpProxy service.

Source

pub fn custom<C2: Connector>( self, connector: C2, on_custom: ProcessCustomSession<SV, C2>, ) -> ProxyServiceBuilder<SV, C2>

Set a custom connector and custom session handler for the ProxyServiceBuilder.

The custom connector is used to establish a connection to the upstream server.

The custom session handler is used to handle custom protocol specific logic between the proxy and the upstream server.

Returns a new ProxyServiceBuilder with the custom connector and session handler.

Source

pub fn server_options(self, options: HttpServerOptions) -> Self

Set the server options for the ProxyServiceBuilder.

Returns a new ProxyServiceBuilder with the server options set.

Source

pub fn build(self) -> Service<HttpProxy<SV, C>>

Builds a new Service from the ProxyServiceBuilder.

This function takes ownership of the ProxyServiceBuilder and returns a new Service with a fully initialized HttpProxy.

The returned Service is ready to be used by a pingora_core::server::Server.

Auto Trait Implementations§

§

impl<SV, C> Freeze for ProxyServiceBuilder<SV, C>
where SV: Freeze, C: Freeze,

§

impl<SV, C> !RefUnwindSafe for ProxyServiceBuilder<SV, C>

§

impl<SV, C> Send for ProxyServiceBuilder<SV, C>

§

impl<SV, C> Sync for ProxyServiceBuilder<SV, C>

§

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

§

impl<SV, C> UnsafeUnpin for ProxyServiceBuilder<SV, C>
where SV: UnsafeUnpin, C: UnsafeUnpin,

§

impl<SV, C> !UnwindSafe for ProxyServiceBuilder<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, 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