Struct WebSocketRelayEventService 

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

Available on crate features http and std and ws only.

A WebSocket MITM relay that exposes every message observable through the high-level WebSocket protocol API to its middleware.

Like WebSocketRelayService, this accepts either raw BridgeIo or an established WebSocketBridge. Use WebSocketRelayIoService when message-level layers must run between protocol construction and this relay.

Unlike WebSocketRelayService, this service exposes ping, pong and close events. Control messages remain owned by the relay: a ping is acknowledged locally and produces an unsolicited pong heartbeat on the opposite connection, while other pongs are not forwarded. An incoming close always starts coordinated shutdown.

Middleware is processed independently per direction. Its future can be cancelled when either peer starts closing, so it must be cancel-safe. Data received after shutdown starts is discarded rather than exposed, and a failure to send middleware-produced data terminates the relay.

Implementations

impl<S> WebSocketRelayEventService<S>

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

Create a new WebSocketRelayEventService.

pub fn with_close_handshake_timeout( self, timeout: Duration, ) -> WebSocketRelayEventService<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 WebSocketRelayEventService<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, ) -> WebSocketRelayEventService<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 WebSocketRelayEventService<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>, ) -> WebSocketRelayEventService<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 WebSocketRelayEventService<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>, ) -> WebSocketRelayEventService<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 WebSocketRelayEventService<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, ) -> WebSocketRelayEventService<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 WebSocketRelayEventService<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) -> WebSocketRelayEventService<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 WebSocketRelayEventService<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 WebSocketRelayEventService<S>

where S: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S> Debug for WebSocketRelayEventService<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 WebSocketRelayEventService<S>

where S: Service<WebSocketRelayEventInput>, <S as Service<WebSocketRelayEventInput>>::Output: Into<WebSocketRelayEventOutput>, <S as Service<WebSocketRelayEventInput>>::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<<WebSocketRelayEventService<S> as Service<BridgeIo<Ingress, Egress>>>::Output, <WebSocketRelayEventService<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 WebSocketRelayEventService<S>

where S: Service<WebSocketRelayEventInput>, <S as Service<WebSocketRelayEventInput>>::Output: Into<WebSocketRelayEventOutput>, <S as Service<WebSocketRelayEventInput>>::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<<WebSocketRelayEventService<S> as Service<WebSocketBridge<Ingress, Egress>>>::Output, <WebSocketRelayEventService<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.