Struct WebSocketRelayService 

pub struct WebSocketRelayService<S = MirrorService> { /* private fields */ }

Available on crate features http and std and ws only.

A utility that can be used by MITM services such as transparent proxies, in order to relay WebSocket messages.

By default they get mirrored but the logic is fully up to you.

This service accepts both a raw BridgeIo and an established WebSocketBridge. Direct raw-I/O use remains convenient and backwards compatible. To install message-level layers, wrap this service in those layers and then place WebSocketRelayIoService around the result.

KISS

This service is for simple DPI purposes.

Ping and pong are handled locally on each of the two independent WebSocket connections and are not exposed to middleware. A ping is acknowledged on its source connection and also produces an unsolicited pong heartbeat on the opposite connection, so activity on one leg keeps both legs alive without coupling their ping round trips. Other pongs are not forwarded. An incoming close starts coordinated shutdown; data received while closing is discarded rather than passed to middleware.

Middleware is processed independently per direction. Its future can be cancelled when either peer starts closing, so it must be cancel-safe. A failure to send middleware-produced data terminates the relay.

Use WebSocketRelayEventService when middleware also needs to observe control messages. Fork or create your own relay service for lower-level purposes such as preserving raw frame boundaries.

Implementations

impl<S> WebSocketRelayService<S>

pub fn new(middleware: S) -> WebSocketRelayService<S>

Create a new WebSocketRelayService

pub fn with_close_handshake_timeout( self, timeout: Duration, ) -> WebSocketRelayService<S>

Set how long the relay waits for both peers to finish a coordinated close handshake before dropping the connections.

The default is five seconds. Both connections and their relay state remain alive until the handshake finishes or this timeout expires.

pub fn set_close_handshake_timeout( &mut self, timeout: Duration, ) -> &mut WebSocketRelayService<S>

Set how long the relay waits for both peers to finish a coordinated close handshake before dropping the connections.

The default is five seconds. Both connections and their relay state remain alive until the handshake finishes or this timeout expires.

pub fn with_message_injection(self, enabled: bool) -> WebSocketRelayService<S>

Enable external application-data injection through a WebSocketRelayInjector exposed to middleware extensions.

Disabled by default, avoiding the liveness channel and extension storage for relays that do not need external message injection.

pub fn set_message_injection( &mut self, enabled: bool, ) -> &mut WebSocketRelayService<S>

Enable external application-data injection through a WebSocketRelayInjector exposed to middleware extensions.

Disabled by default, avoiding the liveness channel and extension storage for relays that do not need external message injection.

pub fn with_message_injection_queue_capacity( self, capacity: NonZero<usize>, ) -> WebSocketRelayService<S>

Set the maximum number of injected messages waiting per relay side.

The default is 16. Once full, WebSocketRelayInjector::send returns ProtocolError::WriteBufferFull without disturbing relay traffic.

pub fn set_message_injection_queue_capacity( &mut self, capacity: NonZero<usize>, ) -> &mut WebSocketRelayService<S>

Set the maximum number of injected messages waiting per relay side.

The default is 16. Once full, WebSocketRelayInjector::send returns ProtocolError::WriteBufferFull without disturbing relay traffic.

pub fn maybe_with_max_injected_message_size( self, max_size: Option<usize>, ) -> WebSocketRelayService<S>

Set the maximum payload size accepted from a relay injector.

The default is 16 MiB. Use Self::without_max_injected_message_size to disable this injector-side limit; the destination WebSocket’s own write limits still apply.

pub fn maybe_set_max_injected_message_size( &mut self, max_size: Option<usize>, ) -> &mut WebSocketRelayService<S>

Set the maximum payload size accepted from a relay injector.

The default is 16 MiB. Use Self::without_max_injected_message_size to disable this injector-side limit; the destination WebSocket’s own write limits still apply.

pub fn with_max_injected_message_size( self, max_size: usize, ) -> WebSocketRelayService<S>

Set the maximum payload size accepted from a relay injector.

The default is 16 MiB. Use Self::without_max_injected_message_size to disable this injector-side limit; the destination WebSocket’s own write limits still apply.

pub fn set_max_injected_message_size( &mut self, max_size: usize, ) -> &mut WebSocketRelayService<S>

Set the maximum payload size accepted from a relay injector.

The default is 16 MiB. Use Self::without_max_injected_message_size to disable this injector-side limit; the destination WebSocket’s own write limits still apply.

pub fn without_max_injected_message_size(self) -> WebSocketRelayService<S>

Set the maximum payload size accepted from a relay injector.

The default is 16 MiB. Use Self::without_max_injected_message_size to disable this injector-side limit; the destination WebSocket’s own write limits still apply.

pub fn unset_max_injected_message_size( &mut self, ) -> &mut WebSocketRelayService<S>

Set the maximum payload size accepted from a relay injector.

The default is 16 MiB. Use Self::without_max_injected_message_size to disable this injector-side limit; the destination WebSocket’s own write limits still apply.

Trait Implementations

impl<S> Clone for WebSocketRelayService<S>

where S: Clone,

fn clone(&self) -> WebSocketRelayService<S>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S> Debug for WebSocketRelayService<S>

where S: Debug,

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

Formats the value using the given formatter.

impl<S, Ingress, Egress> Service<BridgeIo<Ingress, Egress>> for WebSocketRelayService<S>

where S: Service<WebSocketRelayInput>, <S as Service<WebSocketRelayInput>>::Output: Into<WebSocketRelayOutput>, <S as Service<WebSocketRelayInput>>::Error: Into<Box<dyn Error + Send + Sync>>, Ingress: Io + Unpin + ExtensionsRef, Egress: Io + Unpin + ExtensionsRef,

type Output = ()

The type of the output returned by the service.

type Error = !

The type of error returned by the service.

async fn serve( &self, bridge: BridgeIo<Ingress, Egress>, ) -> Result<<WebSocketRelayService<S> as Service<BridgeIo<Ingress, Egress>>>::Output, <WebSocketRelayService<S> as Service<BridgeIo<Ingress, Egress>>>::Error>

Serve an output or an error for the given input

fn boxed(self) -> BoxService<Input, Self::Output, Self::Error>

Box this service to allow for dynamic dispatch.

impl<S, Ingress, Egress> Service<WebSocketBridge<Ingress, Egress>> for WebSocketRelayService<S>

where S: Service<WebSocketRelayInput>, <S as Service<WebSocketRelayInput>>::Output: Into<WebSocketRelayOutput>, <S as Service<WebSocketRelayInput>>::Error: Into<Box<dyn Error + Send + Sync>>, Ingress: WebSocketIo, Egress: WebSocketIo,

type Output = ()

The type of the output returned by the service.

type Error = !

The type of error returned by the service.

async fn serve( &self, __arg1: WebSocketBridge<Ingress, Egress>, ) -> Result<<WebSocketRelayService<S> as Service<WebSocketBridge<Ingress, Egress>>>::Output, <WebSocketRelayService<S> as Service<WebSocketBridge<Ingress, Egress>>>::Error>

Serve an output or an error for the given input

fn boxed(self) -> BoxService<Input, Self::Output, Self::Error>

Box this service to allow for dynamic dispatch.