Struct IoForwardService 

pub struct IoForwardService { /* private fields */ }

Available on crate feature net only.

A proxy Service which takes a BridgeIo and copies the bytes of both the source and target Ios bidirectionally.

The service observes shutdown via the ShutdownGuard of the Executor passed at construction (if any), enforces an optional idle timeout that closes the bridge when neither direction has made byte progress within the configured window, and emits a single structured close event when the bridge ends.

Implementations

impl IoForwardService

pub fn new(executor: Executor) -> IoForwardService

Create a new IoForwardService using the given Executor.

pub fn maybe_with_idle_timeout( self, timeout: Option<Duration>, ) -> IoForwardService

Per-direction idle timeout. When set, the bridge closes with reason BridgeCloseReason::IdleTimeout if no byte progress is observed in either direction within timeout.

None (the default) disables idle detection.

pub fn maybe_set_idle_timeout( &mut self, timeout: Option<Duration>, ) -> &mut IoForwardService

Per-direction idle timeout. When set, the bridge closes with reason BridgeCloseReason::IdleTimeout if no byte progress is observed in either direction within timeout.

None (the default) disables idle detection.

pub fn with_idle_timeout(self, timeout: Duration) -> IoForwardService

Per-direction idle timeout. When set, the bridge closes with reason BridgeCloseReason::IdleTimeout if no byte progress is observed in either direction within timeout.

None (the default) disables idle detection.

pub fn set_idle_timeout(&mut self, timeout: Duration) -> &mut IoForwardService

Per-direction idle timeout. When set, the bridge closes with reason BridgeCloseReason::IdleTimeout if no byte progress is observed in either direction within timeout.

None (the default) disables idle detection.

pub fn without_idle_timeout(self) -> IoForwardService

Per-direction idle timeout. When set, the bridge closes with reason BridgeCloseReason::IdleTimeout if no byte progress is observed in either direction within timeout.

None (the default) disables idle detection.

pub fn unset_idle_timeout(&mut self) -> &mut IoForwardService

Per-direction idle timeout. When set, the bridge closes with reason BridgeCloseReason::IdleTimeout if no byte progress is observed in either direction within timeout.

None (the default) disables idle detection.

pub fn maybe_with_first_byte_timeout( self, timeout: Option<Duration>, ) -> IoForwardService

Response first-byte timeout. When set, the bridge closes with reason BridgeCloseReason::FirstByteTimeout if the upstream (right / egress) half writes no byte within timeout of the window’s start (see first_byte_timeout_start).

This targets a silent origin that accepts the connection but never responds: the client’s bytes still flow toward the upstream, so the flow never looks idle. It keys off the upstream -> client direction only, once the first upstream byte arrives the timer disarms permanently and idle_timeout takes over.

Where the window is anchored (bridge open vs the client’s first sent byte) is controlled by first_byte_timeout_start.

None (the default) disables first-byte detection.

pub fn maybe_set_first_byte_timeout( &mut self, timeout: Option<Duration>, ) -> &mut IoForwardService

Response first-byte timeout. When set, the bridge closes with reason BridgeCloseReason::FirstByteTimeout if the upstream (right / egress) half writes no byte within timeout of the window’s start (see first_byte_timeout_start).

This targets a silent origin that accepts the connection but never responds: the client’s bytes still flow toward the upstream, so the flow never looks idle. It keys off the upstream -> client direction only, once the first upstream byte arrives the timer disarms permanently and idle_timeout takes over.

Where the window is anchored (bridge open vs the client’s first sent byte) is controlled by first_byte_timeout_start.

None (the default) disables first-byte detection.

pub fn with_first_byte_timeout(self, timeout: Duration) -> IoForwardService

Response first-byte timeout. When set, the bridge closes with reason BridgeCloseReason::FirstByteTimeout if the upstream (right / egress) half writes no byte within timeout of the window’s start (see first_byte_timeout_start).

This targets a silent origin that accepts the connection but never responds: the client’s bytes still flow toward the upstream, so the flow never looks idle. It keys off the upstream -> client direction only, once the first upstream byte arrives the timer disarms permanently and idle_timeout takes over.

Where the window is anchored (bridge open vs the client’s first sent byte) is controlled by first_byte_timeout_start.

None (the default) disables first-byte detection.

pub fn set_first_byte_timeout( &mut self, timeout: Duration, ) -> &mut IoForwardService

Response first-byte timeout. When set, the bridge closes with reason BridgeCloseReason::FirstByteTimeout if the upstream (right / egress) half writes no byte within timeout of the window’s start (see first_byte_timeout_start).

This targets a silent origin that accepts the connection but never responds: the client’s bytes still flow toward the upstream, so the flow never looks idle. It keys off the upstream -> client direction only, once the first upstream byte arrives the timer disarms permanently and idle_timeout takes over.

Where the window is anchored (bridge open vs the client’s first sent byte) is controlled by first_byte_timeout_start.

None (the default) disables first-byte detection.

pub fn without_first_byte_timeout(self) -> IoForwardService

Response first-byte timeout. When set, the bridge closes with reason BridgeCloseReason::FirstByteTimeout if the upstream (right / egress) half writes no byte within timeout of the window’s start (see first_byte_timeout_start).

This targets a silent origin that accepts the connection but never responds: the client’s bytes still flow toward the upstream, so the flow never looks idle. It keys off the upstream -> client direction only, once the first upstream byte arrives the timer disarms permanently and idle_timeout takes over.

Where the window is anchored (bridge open vs the client’s first sent byte) is controlled by first_byte_timeout_start.

None (the default) disables first-byte detection.

pub fn unset_first_byte_timeout(&mut self) -> &mut IoForwardService

Response first-byte timeout. When set, the bridge closes with reason BridgeCloseReason::FirstByteTimeout if the upstream (right / egress) half writes no byte within timeout of the window’s start (see first_byte_timeout_start).

This targets a silent origin that accepts the connection but never responds: the client’s bytes still flow toward the upstream, so the flow never looks idle. It keys off the upstream -> client direction only, once the first upstream byte arrives the timer disarms permanently and idle_timeout takes over.

Where the window is anchored (bridge open vs the client’s first sent byte) is controlled by first_byte_timeout_start.

None (the default) disables first-byte detection.

pub fn with_first_byte_timeout_start( self, start: FirstByteTimeoutStart, ) -> IoForwardService

Anchor for the response first-byte window: see FirstByteTimeoutStart. Only meaningful when first_byte_timeout is set.

Default: FirstByteTimeoutStart::ClientFirstByte.

pub fn set_first_byte_timeout_start( &mut self, start: FirstByteTimeoutStart, ) -> &mut IoForwardService

Anchor for the response first-byte window: see FirstByteTimeoutStart. Only meaningful when first_byte_timeout is set.

Default: FirstByteTimeoutStart::ClientFirstByte.

pub fn with_shutdown_grace(self, grace: Duration) -> IoForwardService

Per-half cap on graceful shutdown. When the bridge unwinds it calls shutdown() on each write half bounded by this duration; if the inner type blocks (e.g. a TLS layer waiting for close_notify), the shutdown is abandoned and the half is dropped.

Default: 50ms.

pub fn set_shutdown_grace(&mut self, grace: Duration) -> &mut IoForwardService

Per-half cap on graceful shutdown. When the bridge unwinds it calls shutdown() on each write half bounded by this duration; if the inner type blocks (e.g. a TLS layer waiting for close_notify), the shutdown is abandoned and the half is dropped.

Default: 50ms.

pub fn with_buf_size(self, size: usize) -> IoForwardService

Per-direction copy buffer size (in bytes).

Default: 8 KiB.

pub fn set_buf_size(&mut self, size: usize) -> &mut IoForwardService

Per-direction copy buffer size (in bytes).

Default: 8 KiB.

Trait Implementations

impl Clone for IoForwardService

fn clone(&self) -> IoForwardService

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IoForwardService

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

Formats the value using the given formatter.

impl Default for IoForwardService

fn default() -> IoForwardService

Returns the “default value” for a type.

impl<S, T> Service<BridgeIo<S, T>> for IoForwardService

where S: Io + Unpin, T: Io + Unpin,

type Output = IoForwardOutcome

The type of the output returned by the service.

type Error = IoForwardError

The type of error returned by the service.

async fn serve( &self, __arg1: BridgeIo<S, T>, ) -> Result<<IoForwardService as Service<BridgeIo<S, T>>>::Output, <IoForwardService as Service<BridgeIo<S, T>>>::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.