Skip to main content

WsProxy

Struct WsProxy 

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

WebSocket reverse proxy with round-robin load balancing.

Accepts HTTP/1.1 WebSocket upgrade requests and tunnels traffic to one of the configured backends.

Backend URL schemes:

  • "host:port" — plain TCP (no scheme)
  • "ws://host:port" — plain TCP (port defaults to 80)
  • "wss://host:port" — TLS (port defaults to 443); requires the http-client or http2 Cargo feature

Call WsProxy::bind to start. It blocks the calling thread indefinitely.

Implementations§

Source§

impl WsProxy

Source

pub fn new<I, S>(backends: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Create a proxy that distributes connections across backends in round-robin order. Every backend is treated as always live — no health check is attached; use the config-driven proxy’s [ws_proxy.health_check] for that.

Each entry may be "host:port", "ws://host:port", or "wss://host:port". wss:// requires the http-client or http2 Cargo feature.

Source

pub fn with_live_backends( all_backends: Vec<String>, live: Arc<RwLock<Vec<String>>>, ) -> Self

Build a proxy whose live-backend list is externally managed — live is shared with (and expected to be updated by) a health checker you run yourself, on whatever schedule and probe logic you choose. all_backends is the full configured list, used only for bind()’s empty-configuration check; round-robin only ever picks from live.

This is what the config-driven proxy’s [ws_proxy.health_check] uses internally (see proxy_config::health::start_health_checker), exposed directly for library users who want WS backend health checking without the config file — e.g. a custom probe that performs a real WebSocket handshake rather than a plain HTTP GET.

use std::sync::{Arc, RwLock};
use rust_web_server::ws_proxy::WsProxy;

let all = vec!["ws://chat-a:9000".to_string(), "ws://chat-b:9000".to_string()];
let live = Arc::new(RwLock::new(all.clone()));

// Run your own probe loop on another thread, writing into `live`:
let checker_live = Arc::clone(&live);
std::thread::spawn(move || loop {
    std::thread::sleep(std::time::Duration::from_secs(10));
    // *checker_live.write().unwrap() = probe_and_filter(&all);
    let _ = &checker_live;
});

WsProxy::with_live_backends(all, live)
    .bind("0.0.0.0:8080")
    .expect("WS proxy failed");
Source

pub fn connect_timeout_ms(self, ms: u64) -> Self

Override the TCP connect timeout to each backend (default: 5 s).

Source

pub fn read_timeout_ms(self, ms: u64) -> Self

Override the idle read timeout on client connections (default: 30 s).

For wss:// backends this controls the outer idle timeout on the client side; the internal polling interval is fixed at 5 ms.

Source

pub fn bind(self, addr: &str) -> Result<(), String>

Bind on addr and start proxying WebSocket connections. Blocks indefinitely.

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<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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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