Struct WebSocketRelayService 

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

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) -> Self

Create a new WebSocketRelayService

pub fn with_close_handshake_timeout(self, timeout: Duration) -> Self

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 Self

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.

Trait Implementations

impl<S: Clone> Clone for WebSocketRelayService<S>

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> Debug for WebSocketRelayService<S>

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

Formats the value using the given formatter.

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

where S: Service<WebSocketRelayInput, Output: Into<WebSocketRelayOutput>, Error: Into<BoxError>>, Ingress: Io + Unpin + ExtensionsRef, Egress: Io + Unpin + ExtensionsRef,

type Output = ()

The type of the output returned by the service.

type Error = Infallible

The type of error returned by the service.

async fn serve( &self, bridge: BridgeIo<Ingress, Egress>, ) -> Result<Self::Output, Self::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, Output: Into<WebSocketRelayOutput>, Error: Into<BoxError>>, Ingress: WebSocketIo, Egress: WebSocketIo,

type Output = ()

The type of the output returned by the service.

type Error = Infallible

The type of error returned by the service.

async fn serve( &self, __arg1: WebSocketBridge<Ingress, Egress>, ) -> Result<Self::Output, Self::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.