Struct LingeringClose 

pub struct LingeringClose { /* private fields */ }

Available on crate feature net only.

Bounds of a lingering close: after shutting down its own side, a connection keeps reading and discarding what its peer still sends before it is closed.

Closing a socket that still has unread input sends a reset instead of a clean close, and on Windows a reset makes the peer discard what it has not read yet, such as the tail of a response that was just sent to it. The same happens when the peer sends after the socket was closed. Lingering keeps the socket open until the peer is done, as nginx does with lingering_close.

A connection lingers until its peer ends the stream, nothing arrives for idle_timeout, timeout passes in total, or max_bytes (if set) were read and discarded, whichever comes first. A peer that is still sending is waited for, so the total timeout is what bounds a slow one. Used by IoForwardService and rama’s HTTP/1 server, which say when a connection lingers.

The total of 30 seconds is nginx’s lingering_time. The idle timeout of 2 seconds is shorter than nginx’s lingering_timeout of 5, as the peer only has to finish what it was already sending.

Implementations

impl LingeringClose

pub const fn new() -> LingeringClose

Linger while data keeps arriving within 2 seconds, for at most 30 seconds in total, without a byte limit.

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

Stop lingering once nothing arrived for this long. If this is at least the total timeout, the total limit wins instead. HTTP/1 servers can then abort a blocked response even for an idle client.

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

Stop lingering once nothing arrived for this long. If this is at least the total timeout, the total limit wins instead. HTTP/1 servers can then abort a blocked response even for an idle client.

pub fn with_timeout(self, timeout: Duration) -> LingeringClose

Stop lingering once this long passed in total.

pub fn set_timeout(&mut self, timeout: Duration) -> &mut LingeringClose

Stop lingering once this long passed in total.

pub fn maybe_with_max_bytes(self, max: Option<u64>) -> LingeringClose

Stop lingering once this many bytes were read and discarded. None (the default) sets no limit.

pub fn maybe_set_max_bytes(&mut self, max: Option<u64>) -> &mut LingeringClose

Stop lingering once this many bytes were read and discarded. None (the default) sets no limit.

pub fn with_max_bytes(self, max: u64) -> LingeringClose

Stop lingering once this many bytes were read and discarded. None (the default) sets no limit.

pub fn set_max_bytes(&mut self, max: u64) -> &mut LingeringClose

Stop lingering once this many bytes were read and discarded. None (the default) sets no limit.

pub fn without_max_bytes(self) -> LingeringClose

Stop lingering once this many bytes were read and discarded. None (the default) sets no limit.

pub fn unset_max_bytes(&mut self) -> &mut LingeringClose

Stop lingering once this many bytes were read and discarded. None (the default) sets no limit.

pub const fn idle_timeout(&self) -> Duration

How long a lingering connection waits for more data.

pub const fn timeout(&self) -> Duration

How long a connection lingers at most.

pub const fn max_bytes(&self) -> Option<u64>

How many bytes a connection reads and discards at most while lingering, if limited.

pub const fn is_enabled(&self) -> bool

Whether these bounds let a connection linger at all.

Trait Implementations

impl Clone for LingeringClose

fn clone(&self) -> LingeringClose

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LingeringClose

impl Debug for LingeringClose

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

Formats the value using the given formatter.

impl Default for LingeringClose

fn default() -> LingeringClose

Returns the “default value” for a type.

impl Eq for LingeringClose

impl PartialEq for LingeringClose

fn eq(&self, other: &LingeringClose) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for LingeringClose