rs-netty 1.0.0

A Tokio-native typed TCP/UDP pipeline framework inspired by Netty.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

use std::time::Duration;

/// TCP connection runtime configuration.
///
/// The same settings are used by accepted server connections and client
/// connections.
#[derive(Clone)]
pub struct TcpConnectionConfig {
    /// Initial read buffer capacity in bytes.
    ///
    /// The buffer can grow as Tokio reads more bytes, but a connection is
    /// closed if buffered data exceeds [`Self::max_frame_size`] before the
    /// codec can produce a frame.
    pub read_buffer_capacity: usize,
    /// Initial write buffer capacity in bytes.
    ///
    /// Encoded outbound frames are accumulated here before being written to the
    /// socket.
    pub write_buffer_capacity: usize,
    /// Maximum buffered frame size before closing the connection.
    pub max_frame_size: usize,
    /// Bounded outbound command queue size for writes sent through channels.
    ///
    /// Calls such as [`crate::Channel::write`] wait for capacity when this
    /// queue is full.
    pub outbound_queue_size: usize,
    /// Whether `TCP_NODELAY` is enabled.
    pub tcp_nodelay: bool,
    /// Optional timeout for closing a connection after no reads are received.
    ///
    /// Outbound writes do not reset this timer.
    pub idle_timeout: Option<Duration>,
    /// Whether byte and frame counters are collected for the connection.
    ///
    /// Disabled by default so applications that do not need stats avoid the
    /// shared counter allocations and atomic updates.
    pub track_connection_stats: bool,
}

impl Default for TcpConnectionConfig {
    fn default() -> Self {
        Self {
            read_buffer_capacity: 8 * 1024,
            write_buffer_capacity: 8 * 1024,
            max_frame_size: 1024 * 1024,
            outbound_queue_size: 1024,
            tcp_nodelay: true,
            idle_timeout: None,
            track_connection_stats: false,
        }
    }
}