Skip to main content

ForwarderClient

Struct ForwarderClient 

Source
pub struct ForwarderClient { /* private fields */ }
Expand description

Forwarder client for sending requests to upstream backends.

Implementations§

Source§

impl ForwarderClient

Source

pub fn new(timeout: Duration) -> Self

Create a new forwarder client.

Source

pub async fn forward( &self, backend: &Backend, request: Request<BoxBody<Bytes, Error>>, ) -> Result<Response<Incoming>, ProxyError>

Forward a request to a backend.

Source

pub async fn forward_upgrade( &self, backend: &Backend, request: Request<BoxBody<Bytes, Error>>, ) -> Result<Response<BoxBody<Bytes, Error>>, ProxyError>

Forward a protocol-upgrade request (WebSocket) and tunnel the result.

This cannot use the pooled client: once the upstream answers 101 the connection stops being request/response and becomes an opaque byte stream, which a connection pool has no way to hand back. So dial the backend directly, keep the lower-level connection, and splice the two upgraded halves together.

HTTP/1.1 only. WebSocket over HTTP/2 is RFC 8441 extended CONNECT, a different mechanism that this does not implement.

Source

pub async fn forward_h2_websocket( &self, backend: &Backend, request: Request<BoxBody<Bytes, Error>>, protocol: &str, ) -> Result<Response<BoxBody<Bytes, Error>>, ProxyError>

Forward an HTTP/2 extended CONNECT (RFC 8441) to an HTTP/1.1 WebSocket origin, translating between the two handshakes.

The two are not the same conversation, so this is a rewrite rather than a relay:

  • HTTP/2 carries the intent in :method = CONNECT and :protocol; HTTP/1.1 carries it in Upgrade plus a Connection token.
  • HTTP/2 has no Sec-WebSocket-Key. The nonce exists to stop an HTTP/1.1 cache from mistaking the handshake for an ordinary response, which does not apply to a multiplexed stream. The h1 origin still requires one, so the proxy generates it here.
  • Success is 101 on the wire to the origin but 200 back to the client; a 101 has no meaning on an HTTP/2 stream.

The origin’s Sec-WebSocket-Accept is not verified against the generated key. Status 101 plus a websocket Upgrade is taken as sufficient, which avoids a SHA-1 dependency for a check that guards against a misconfigured origin rather than an attacker.

Trait Implementations§

Source§

impl Default for ForwarderClient

Source§

fn default() -> Self

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

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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> 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 = !

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