Struct spirit_tokio::net::TcpConfig

#[non_exhaustive]pub struct TcpConfig {
    pub nodelay: Option<bool>,
    pub recv_buf_size: Option<usize>,
    pub send_buf_size: Option<usize>,
    pub keepalive: MaybeDuration,
    pub accepted_ttl: Option<u32>,
}

An implementation of the StreamConfig trait to configure TCP connections.

This is an implementation that allows the user configure several options of accepted TCP connections.

This is also the default implementation if none is specified for TcpListen.

Fields

• tcp-nodelay (optional, boolean, if not set uses OS default)
• tcp-recv-buf-size (optional, size of the OS buffer on the receive end of the socket, if not set uses the OS default)
• tcp-send-buf-size (similar, but for the send end)
• tcp-keepalive (optional, see MaybeDuration)
• accepted-ttl (optional, uses OS default if not set)

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

nodelay: Option<bool>

The TCP_NODELAY option.

If set to true, packets are sent as soon as there are some data queued by the application. This is faster, but may create more (undersized) packets in some circumstances.

Setting this to false sends the first undersized packet, but then it waits to either receive ACK from the other side or for enough data to fill a whole packet before sending another.

Left to OS default if not set.

recv_buf_size: Option<usize>

The receive buffer size of the connection, in bytes.

Left to OS default if not set.

send_buf_size: Option<usize>

The send buffer size of the connection, in bytes.

Left to the OS default if not set.

keepalive: MaybeDuration

The TCP keepalive time.

If set to interval (for example 5m or 30s), a TCP keepalive packet will be sent every this often. If set to false, TCP keepalive will be turned off.

Left to the OS default if not set.

accepted_ttl: Option<u32>

The IP TTL field of packets sent through an accepted connection.

Left to the OS default if not set.

Trait Implementations

impl Clone for TcpConfig

fn clone(&self) -> TcpConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TcpConfig

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

Formats the value using the given formatter.

impl Default for TcpConfig

fn default() -> TcpConfig

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for TcpConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for TcpConfig

impl Hash for TcpConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for TcpConfig

fn cmp(&self, other: &TcpConfig) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<TcpConfig> for TcpConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<TcpConfig> for TcpConfig

fn partial_cmp(&self, other: &TcpConfig) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &TcpConfig) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &TcpConfig) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &TcpConfig) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &TcpConfig) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for TcpConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StreamConfig<TcpStream> for TcpConfig

fn configure(&self, stream: &mut TcpStream) -> Result<(), IoError>

Applies the configuration to the stream.

impl StructDoc for TcpConfig

fn document() -> Documentation

Returns the documentation for the type.

impl StructuralEq for TcpConfig

impl StructuralPartialEq for TcpConfig