kcp-io 0.0.5

A Rust wrapper for the KCP protocol — FFI bindings, safe API, and async tokio integration
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

//! Runtime configuration for async KCP sessions.
//!
//! This module defines [`KcpSessionConfig`], which combines the low-level
//! KCP protocol parameters ([`KcpConfig`](crate::core::KcpConfig)) with
//! session-level runtime settings such as flush interval, timeout, and
//! buffer sizes.

use crate::core::KcpConfig;
use std::time::Duration;

/// Configuration for async KCP sessions.
///
/// Combines the KCP protocol parameters ([`KcpConfig`](crate::core::KcpConfig))
/// with runtime settings that control session behavior in the async layer.
///
/// # Example
///
/// ```
/// use kcp_io::tokio_rt::KcpSessionConfig;
///
/// // Use a preset
/// let config = KcpSessionConfig::fast();
///
/// // Customize from a preset
/// let config = KcpSessionConfig {
///     timeout: Some(std::time::Duration::from_secs(60)),
///     ..KcpSessionConfig::fast()
/// };
/// ```
#[derive(Debug, Clone)]
pub struct KcpSessionConfig {
    /// The underlying KCP protocol configuration.
    pub kcp_config: KcpConfig,
    /// How often the KCP state machine is updated (drives retransmission and flushing).
    /// This is automatically derived from [`KcpConfig::interval`] in the presets.
    pub flush_interval: Duration,
    /// Session timeout. If no data is received within this duration, the session
    /// is considered dead and will return [`KcpTokioError::Timeout`](super::KcpTokioError::Timeout).
    /// Set to `None` to disable timeout.
    pub timeout: Option<Duration>,
    /// Whether to immediately flush after each write operation. When `true`,
    /// `send_kcp()` calls `kcp.flush()` after sending, reducing latency at
    /// the cost of potentially more packets.
    pub flush_write: bool,
    /// Size of the internal UDP receive buffer in bytes. Should be large enough
    /// to hold the largest expected UDP datagram. Default: 65536.
    pub recv_buf_size: usize,
}

impl Default for KcpSessionConfig {
    /// Returns a default session configuration using [`KcpConfig::default()`].
    ///
    /// - flush_interval: derived from `KcpConfig.interval` (100ms)
    /// - timeout: `None` (no timeout)
    /// - flush_write: `true`
    /// - recv_buf_size: `65536`
    fn default() -> Self {
        let kcp_config = KcpConfig::default();
        Self {
            flush_interval: Duration::from_millis(kcp_config.interval as u64),
            kcp_config,
            timeout: None,
            flush_write: true,
            recv_buf_size: 65536,
        }
    }
}

impl KcpSessionConfig {
    /// Returns a low-latency (fast) session configuration.
    ///
    /// Uses [`KcpConfig::fast()`] with a 30-second timeout.
    pub fn fast() -> Self {
        let kcp_config = KcpConfig::fast();
        Self {
            flush_interval: Duration::from_millis(kcp_config.interval as u64),
            kcp_config,
            timeout: Some(Duration::from_secs(30)),
            flush_write: true,
            recv_buf_size: 65536,
        }
    }

    /// Returns a balanced (normal) session configuration.
    ///
    /// Uses [`KcpConfig::normal()`] with a 60-second timeout.
    pub fn normal() -> Self {
        let kcp_config = KcpConfig::normal();
        Self {
            flush_interval: Duration::from_millis(kcp_config.interval as u64),
            kcp_config,
            timeout: Some(Duration::from_secs(60)),
            flush_write: true,
            recv_buf_size: 65536,
        }
    }
}