kestrel-protocol-timer 0.1.1

基于时间轮(Timing Wheel)算法的高性能异步定时器系统
Documentation

Kestrel Protocol Timer

基于时间轮(Timing Wheel)算法的高性能异步定时器系统

Rust Tokio Crates.io Documentation Downloads License

📚 目录

项目概述

kestrel-protocol-timer 是一个基于时间轮(Timing Wheel)算法实现的高性能异步定时器库,专为 Rust 和 tokio 异步运行时设计。它能够高效管理大规模并发定时器任务,提供 O(1) 时间复杂度的插入和删除操作。

为什么选择 Kestrel Timer?

  • 极致性能:相比传统的堆(Heap)实现,时间轮算法在大规模定时器场景下具有显著的性能优势
  • 可扩展性:轻松处理 10,000+ 并发定时器而不影响性能
  • 生产就绪:经过严格测试,包含完整的单元测试、集成测试和性能基准测试
  • 灵活易用:提供简洁的 API,支持单个和批量操作,内置完成通知机制
  • 零成本抽象:充分利用 Rust 的类型系统和零成本抽象特性

核心特性

⚡ 高性能

  • O(1) 时间复杂度:插入、删除和触发操作均为 O(1)
  • 优化的数据结构:使用 FxHashMap 减少哈希冲突,parking_lot::Mutex 提供更快的锁机制
  • 位运算优化:槽位数量为 2 的幂次方,使用位运算替代取模操作

🚀 大规模支持

  • 支持 10,000+ 并发定时器
  • 批量操作优化,减少锁竞争
  • 独立的 tokio 任务执行,避免阻塞时间轮推进

🔄 异步支持

  • 完全基于 tokio 异步运行时
  • 异步回调函数支持
  • 非阻塞的定时器管理

🔒 线程安全

  • 多线程环境下安全使用
  • 使用 parking_lot::Mutex 提供高性能的锁机制
  • 无数据竞争保证

📦 批量操作

  • 批量调度定时器,减少锁开销
  • 批量取消定时器
  • 批量完成通知

🔔 完成通知

  • 内置任务完成通知机制
  • 支持仅通知的定时器(无回调)
  • 异步等待定时器完成

⚙️ 灵活配置

  • 可配置槽位数量
  • 可配置时间精度(tick 时长)
  • 默认配置开箱即用

快速开始

use kestrel_protocol_timer::TimerWheel;
use std::time::Duration;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // 创建定时器(使用默认配置)
    let timer = TimerWheel::with_defaults()?;
    
    // 调度一个 1 秒后触发的定时器
    let handle = timer.schedule_once(Duration::from_secs(1), || async {
        println!("定时器触发!");
    }).await?;
    
    // 等待定时器完成
    handle.into_completion_receiver().0.await.ok();
    
    println!("定时器执行完成");
    Ok(())
}

安装

Cargo.toml 中添加依赖:

[dependencies]
kestrel-protocol-timer = "0.1.0"
tokio = { version = "1.48", features = ["full"] }

系统要求

  • Rust 1.70 或更高版本
  • Tokio 1.48 或更高版本

架构说明

时间轮算法原理

时间轮是一个环形数组结构,每个槽位(slot)存储一组到期时间相近的定时器任务。时间轮以固定的频率(tick)推进,当指针移动到某个槽位时,该槽位中的所有任务会被检查是否到期。

        槽位 0          槽位 1          槽位 2
         │               │               │
    ┌────┴────┐     ┌────┴────┐     ┌────┴────┐
    │ 任务 A  │     │ 任务 C  │     │         │
    │ 任务 B  │     │         │     │         │
    └─────────┘     └─────────┘     └─────────┘
         ▲
         │
    当前指针(current_tick)

核心参数

  • 槽位数量:默认 512 个(必须是 2 的幂次方以优化性能)
  • 时间精度(tick_duration):默认 10ms
  • 最大时间跨度:槽位数量 × tick_duration = 5.12 秒
  • 轮次机制(rounds):超出时间轮范围的任务使用轮次计数处理

工作流程

  1. 插入任务:计算任务的到期 tick 和所属槽位,插入对应槽位
  2. 推进时间轮:每个 tick 间隔,指针前进一位
  3. 触发任务:检查当前槽位的任务,触发轮次为 0 的任务
  4. 执行回调:在独立的 tokio 任务中执行回调函数

核心组件

1. TimerWheel

主定时器接口,提供定时器的创建、调度和管理功能。

pub struct TimerWheel {
    wheel: Arc<Mutex<Wheel>>,
    driver_handle: JoinHandle<()>,
}

职责

  • 管理时间轮实例
  • 启动和停止时间轮驱动器
  • 提供调度 API

2. Wheel

时间轮的核心实现,负责任务的存储、查找和触发。

pub struct Wheel {
    slots: Vec<Vec<TimerTask>>,      // 槽位数组
    current_tick: u64,                // 当前 tick
    slot_count: usize,                // 槽位数量
    tick_duration: Duration,          // tick 时长
    task_index: FxHashMap<TaskId, TaskLocation>, // 任务索引
}

职责

  • 存储和管理定时器任务
  • 执行时间轮的推进逻辑
  • 处理任务的插入、取消和触发

3. TimerHandle / BatchHandle

定时器句柄,用于管理单个或批量定时器的生命周期。

pub struct TimerHandle {
    task_id: TaskId,
    wheel: Arc<Mutex<Wheel>>,
    completion_rx: CompletionReceiver,
}

职责

  • 取消定时器
  • 获取任务 ID
  • 接收完成通知

4. TimerService

基于 Actor 模式的定时器服务管理器,提供集中式的定时器管理。

pub struct TimerService {
    command_tx: mpsc::Sender<ServiceCommand>,
    timeout_rx: Option<mpsc::Receiver<TaskId>>,
    actor_handle: Option<JoinHandle<()>>,
    wheel: Arc<Mutex<Wheel>>,
}

职责

  • 集中管理多个定时器句柄
  • 自动监听超时事件
  • 将超时的 TaskId 聚合转发给用户

5. TimerTask

定时器任务的封装,包含任务的元数据和回调函数。

pub struct TimerTask {
    id: TaskId,
    deadline_tick: u64,
    rounds: u32,
    callback: Option<CallbackWrapper>,
    completion_notifier: CompletionNotifier,
}

性能优化

  1. 高效锁机制:使用 parking_lot::Mutex 替代标准库 Mutex,减少锁开销
  2. 优化哈希表:使用 FxHashMap(rustc-hash)替代标准 HashMap,减少哈希冲突
  3. 位运算优化:槽位数量为 2 的幂次方,使用 & (slot_count - 1) 替代 % slot_count
  4. 独立任务执行:回调函数在独立的 tokio 任务中执行,避免阻塞时间轮推进
  5. 批量操作:减少锁的获取次数,提高吞吐量
  6. SmallVec 优化:在合适的场景使用 smallvec 减少小型集合的堆分配

使用示例

基础用法

创建定时器

use kestrel_protocol_timer::TimerWheel;
use std::time::Duration;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // 使用默认配置(512 槽位,10ms tick)
    let timer = TimerWheel::with_defaults()?;
    
    // 或使用自定义配置
    let timer = TimerWheel::new(
        Duration::from_millis(10),  // tick 时长
        512,                         // 槽位数量
    )?;
    
    Ok(())
}

调度单个定时器

use std::sync::Arc;
use std::sync::atomic::{AtomicU32, Ordering};

let timer = TimerWheel::with_defaults()?;
let counter = Arc::new(AtomicU32::new(0));
let counter_clone = Arc::clone(&counter);

// 调度一个 100ms 后触发的定时器
let handle = timer.schedule_once(
    Duration::from_millis(100),
    move || {
        let counter = Arc::clone(&counter_clone);
        async move {
            counter.fetch_add(1, Ordering::SeqCst);
            println!("定时器触发!");
        }
    },
).await?;

// 等待定时器完成
handle.into_completion_receiver().0.await.ok();

取消定时器

let timer = TimerWheel::with_defaults()?;

let handle = timer.schedule_once(
    Duration::from_secs(10),
    || async {
        println!("这条消息不会被打印");
    },
).await?;

// 取消定时器
let cancelled = handle.cancel();
println!("取消成功: {}", cancelled);

批量操作

批量调度定时器

let timer = TimerWheel::with_defaults()?;
let counter = Arc::new(AtomicU32::new(0));

// 创建 100 个定时器回调
let callbacks: Vec<_> = (0..100)
    .map(|i| {
        let counter = Arc::clone(&counter);
        let delay = Duration::from_millis(100 + i * 10);
        let callback = move || {
            let counter = Arc::clone(&counter);
            async move {
                counter.fetch_add(1, Ordering::SeqCst);
            }
        };
        (delay, callback)
    })
    .collect();

// 批量调度
let batch_handle = timer.schedule_once_batch(callbacks).await?;

println!("已调度 {} 个定时器", batch_handle.len());

批量取消定时器

let timer = TimerWheel::with_defaults()?;

// 创建批量定时器
let callbacks: Vec<_> = (0..50)
    .map(|_| (Duration::from_secs(10), || async {}))
    .collect();

let batch_handle = timer.schedule_once_batch(callbacks).await?;

// 批量取消
let cancelled_count = batch_handle.cancel_all();
println!("已取消 {} 个定时器", cancelled_count);

完成通知

等待单个定时器完成

let timer = TimerWheel::with_defaults()?;

let handle = timer.schedule_once(
    Duration::from_millis(100),
    || async {
        println!("定时器触发");
    },
).await?;

// 等待定时器完成
match handle.into_completion_receiver().0.await {
    Ok(_) => println!("定时器已完成"),
    Err(_) => println!("定时器被取消"),
}

批量完成通知

let timer = TimerWheel::with_defaults()?;
let counter = Arc::new(AtomicU32::new(0));

// 创建批量定时器
let callbacks: Vec<_> = (0..10)
    .map(|i| {
        let counter = Arc::clone(&counter);
        let delay = Duration::from_millis(50 + i * 10);
        let callback = move || {
            let counter = Arc::clone(&counter);
            async move {
                counter.fetch_add(1, Ordering::SeqCst);
            }
        };
        (delay, callback)
    })
    .collect();

let batch_handle = timer.schedule_once_batch(callbacks).await?;

// 获取所有完成通知接收器
let receivers = batch_handle.into_completion_receivers();

// 等待所有定时器完成
for (i, rx) in receivers.into_iter().enumerate() {
    rx.await.ok();
    println!("定时器 {} 已完成", i);
}

println!("所有定时器已完成,共触发 {}", counter.load(Ordering::SeqCst));

仅通知的定时器(无回调)

let timer = TimerWheel::with_defaults()?;

// 调度一个仅发送通知的定时器(无回调函数)
let handle = timer.schedule_once_notify(Duration::from_millis(100)).await?;

// 等待通知
handle.into_completion_receiver().0.await.ok();
println!("定时器到期");

TimerService 使用

TimerService 提供基于 Actor 模式的集中式定时器管理,适合需要统一处理大量定时器超时事件的场景。

创建和使用 TimerService

use kestrel_protocol_timer::{TimerWheel, TimerService};

let timer = TimerWheel::with_defaults()?;
let mut service = timer.create_service();

// 通过 service 调度定时器
let task_id = service.schedule_once(
    Duration::from_millis(100),
    || async {
        println!("通过 service 调度的定时器触发");
    }
).await?;

println!("已调度任务 ID: {:?}", task_id);

批量调度并接收超时通知

let timer = TimerWheel::with_defaults()?;
let mut service = timer.create_service();

// 批量调度定时器
let callbacks: Vec<_> = (0..100)
    .map(|_| (Duration::from_millis(100), || async {}))
    .collect();

let task_ids = service.schedule_once_batch(callbacks).await?;
println!("已调度 {} 个任务", task_ids.len());

// 获取超时通知接收器
let mut timeout_rx = service.take_receiver()
    .expect("接收器只能被获取一次");

// 接收超时通知
let mut completed_count = 0;
while let Some(task_id) = timeout_rx.recv().await {
    completed_count += 1;
    println!("任务 {:?} 已完成", task_id);
    
    if completed_count >= 100 {
        break;
    }
}

// 关闭 service
service.shutdown().await;

动态添加和取消任务

let timer = TimerWheel::with_defaults()?;
let mut service = timer.create_service();

// 通过 TimerWheel 直接调度
let handle = timer.schedule_once(
    Duration::from_secs(5),
    || async { println!("任务 1 触发"); }
).await?;

// 将句柄添加到 service 管理
service.add_handle(handle).await?;

// 直接取消并通知 service
let task_id2 = service.schedule_once(
    Duration::from_secs(10),
    || async { println!("任务 2 触发"); }
).await?;

service.cancel_and_notify(vec![task_id2]).await?;

API 文档

TimerWheel

构造方法

TimerWheel::with_defaults() -> Result<Self, TimerError>

使用默认配置创建定时器:

  • 槽位数量:512
  • tick 时长:10ms
let timer = TimerWheel::with_defaults()?;

TimerWheel::new(tick_duration: Duration, slot_count: usize) -> Result<Self, TimerError>

使用自定义配置创建定时器。

参数:

  • tick_duration:每个 tick 的时间长度
  • slot_count:槽位数量(必须是 2 的幂次方)
let timer = TimerWheel::new(Duration::from_millis(5), 1024)?;

调度方法

schedule_once<F, Fut>(&self, delay: Duration, callback: F) -> Result<TimerHandle, TimerError>

调度一个单次执行的定时器。

参数:

  • delay:延迟时间
  • callback:回调函数,返回一个 Future

返回:

  • TimerHandle:定时器句柄
let handle = timer.schedule_once(Duration::from_secs(1), || async {
    println!("1 秒后执行");
}).await?;

schedule_once_notify(&self, delay: Duration) -> Result<TimerHandle, TimerError>

调度一个仅发送通知的定时器(无回调函数)。

let handle = timer.schedule_once_notify(Duration::from_secs(1)).await?;
handle.into_completion_receiver().0.await.ok();

schedule_once_batch<F, Fut>(&self, callbacks: Vec<(Duration, F)>) -> Result<BatchHandle, TimerError>

批量调度多个定时器。

参数:

  • callbacks:(延迟时间, 回调函数) 的向量

返回:

  • BatchHandle:批量句柄
let callbacks = vec![
    (Duration::from_secs(1), || async { println!("1"); }),
    (Duration::from_secs(2), || async { println!("2"); }),
];
let batch = timer.schedule_once_batch(callbacks).await?;

服务方法

create_service(&self) -> TimerService

创建一个 TimerService 实例,用于集中管理定时器。

let service = timer.create_service();

TimerHandle

cancel(&self) -> bool

取消定时器。

返回:

  • true:成功取消
  • false:任务已不存在(可能已触发或被取消)
let cancelled = handle.cancel();

task_id(&self) -> TaskId

获取任务 ID。

let id = handle.task_id();

into_completion_receiver(self) -> CompletionReceiver

消耗句柄,返回完成通知接收器。

let receiver = handle.into_completion_receiver();
receiver.0.await.ok();

BatchHandle

len(&self) -> usize

获取批量句柄中的任务数量。

let count = batch.len();

cancel_all(&self) -> usize

取消所有定时器。

返回:成功取消的任务数量。

let cancelled = batch.cancel_all();

into_completion_receivers(self) -> Vec<CompletionReceiver>

消耗批量句柄,返回所有完成通知接收器。

let receivers = batch.into_completion_receivers();
for rx in receivers {
    rx.await.ok();
}

TimerService

schedule_once<F, Fut>(&self, delay: Duration, callback: F) -> Result<TaskId, TimerError>

通过服务调度单个定时器。

返回:任务 ID

let task_id = service.schedule_once(Duration::from_secs(1), || async {}).await?;

schedule_once_batch<F, Fut>(&self, callbacks: Vec<(Duration, F)>) -> Result<Vec<TaskId>, TimerError>

通过服务批量调度定时器。

返回:任务 ID 列表

let callbacks = vec![(Duration::from_secs(1), || async {})];
let task_ids = service.schedule_once_batch(callbacks).await?;

take_receiver(&mut self) -> Option<mpsc::Receiver<TaskId>>

获取超时通知接收器(只能调用一次)。

let mut rx = service.take_receiver().unwrap();
while let Some(task_id) = rx.recv().await {
    println!("任务 {:?} 超时", task_id);
}

cancel_and_notify(&self, task_ids: Vec<TaskId>) -> Result<(), TimerError>

取消指定的任务并通知 service 清理。

service.cancel_and_notify(vec![task_id1, task_id2]).await?;

shutdown(self) -> ()

关闭服务。

service.shutdown().await;

配置选项

槽位数量(slot_count)

槽位数量决定了时间轮的精细度和可覆盖的时间范围。

  • 必须是 2 的幂次方:128, 256, 512, 1024, 2048 等
  • 默认值:512
  • 影响
    • 更多槽位 → 更精细的时间分布,减少哈希冲突,但占用更多内存
    • 更少槽位 → 更少内存占用,但可能增加槽位冲突

推荐配置

  • 小规模定时器(< 1000):256 或 512
  • 中等规模(1000-10000):512 或 1024
  • 大规模(> 10000):1024 或 2048

Tick 时长(tick_duration)

Tick 时长决定了定时器的精度和时间轮推进的频率。

  • 默认值:10ms
  • 影响
    • 更小的 tick → 更高的精度,但更频繁的推进操作
    • 更大的 tick → 更低的 CPU 占用,但精度降低

推荐配置

  • 高精度场景(如网络超时):5ms - 10ms
  • 一般场景:10ms - 50ms
  • 低精度场景(如心跳检测):100ms - 1000ms

最佳实践

// 高精度、大规模场景
let timer = TimerWheel::new(
    Duration::from_millis(5),   // 5ms 精度
    2048,                        // 2048 槽位,覆盖约 10 秒
)?;

// 一般场景
let timer = TimerWheel::new(
    Duration::from_millis(10),  // 10ms 精度
    512,                         // 512 槽位,覆盖约 5 秒
)?;

// 低精度、长时间场景
let timer = TimerWheel::new(
    Duration::from_millis(100), // 100ms 精度
    1024,                        // 1024 槽位,覆盖约 102 秒
)?;

性能基准

项目包含完整的性能基准测试,使用 Criterion 框架实现。

运行基准测试

# 运行所有基准测试
cargo bench

# 运行特定基准测试
cargo bench --bench service_benchmark
cargo bench --bench wheel_benchmark

基准测试项目

1. 单个定时器调度

测试单个定时器的调度性能。

cargo bench schedule_single

典型结果:单次调度耗时约 5-10 微秒

2. 批量调度

测试批量调度不同规模定时器的性能。

cargo bench schedule_batch

测试规模:10、100、1000 个定时器

典型结果

  • 10 个定时器:约 50-80 微秒(每个 5-8 微秒)
  • 100 个定时器:约 300-500 微秒(每个 3-5 微秒)
  • 1000 个定时器:约 2-4 毫秒(每个 2-4 微秒)

批量操作明显比单个操作更高效。

3. 取消操作

测试单个和批量取消的性能。

cargo bench cancel_single
cargo bench cancel_batch

典型结果

  • 单个取消:约 1-3 微秒
  • 批量取消(1000 个):约 1-2 毫秒

4. 并发调度

测试多线程并发调度的性能。

cargo bench concurrent_schedule

5. 时间轮推进

测试时间轮推进操作的性能。

cargo bench wheel_advance

性能对比

与基于堆(BinaryHeap)的传统定时器实现相比:

操作 时间轮 堆实现 优势
插入单个任务 O(1) ~5μs O(log n) ~10-20μs 2-4x 更快
批量插入 1000 O(1000) ~2ms O(1000 log n) ~15-25ms 7-12x 更快
取消任务 O(1) ~2μs O(n) ~50-100μs 25-50x 更快
触发到期任务 O(k) O(k log n) 更稳定

:k 为到期任务数量,n 为总任务数量

大规模测试

集成测试包含大规模场景测试:

cargo test --test integration_test test_large_scale_timers

测试场景:

  • ✅ 10,000 个并发定时器
  • ✅ 创建时间 < 100ms
  • ✅ 所有定时器正确触发
  • ✅ 内存占用稳定

测试

运行测试

# 运行所有测试
cargo test

# 运行单元测试
cargo test --lib

# 运行集成测试
cargo test --test integration_test

# 运行特定测试
cargo test test_basic_timer

测试覆盖

项目包含完整的测试套件:

单元测试

  • ✅ 基本定时器调度和触发
  • ✅ 多定时器管理
  • ✅ 定时器取消
  • ✅ 完成通知机制
  • ✅ 批量操作
  • ✅ 错误处理

集成测试

  • ✅ 大规模定时器(10,000+)
  • ✅ 定时器精度测试
  • ✅ 并发操作测试
  • ✅ 不同延迟的定时器
  • ✅ TimerService 功能测试
  • ✅ 批量取消测试

性能测试

  • ✅ 调度性能基准
  • ✅ 取消性能基准
  • ✅ 批量操作性能基准
  • ✅ 时间轮推进性能基准

使用场景

1. 网络超时管理

use std::time::Duration;

// 为每个网络连接设置超时
async fn handle_connection(timer: &TimerWheel, conn_id: u64) {
    let timeout_handle = timer.schedule_once(
        Duration::from_secs(30),
        move || async move {
            println!("连接 {} 超时,关闭连接", conn_id);
            // 关闭连接逻辑
        }
    ).await.unwrap();
    
    // 如果连接完成,取消超时
    // timeout_handle.cancel();
}

2. 任务延迟执行

// 延迟 5 秒执行清理任务
timer.schedule_once(
    Duration::from_secs(5),
    || async {
        cleanup_temporary_files().await;
    }
).await?;

3. 心跳检测

let timer = TimerWheel::new(Duration::from_secs(1), 512)?;
let mut service = timer.create_service();

// 为每个客户端设置心跳检测
for client_id in client_ids {
    service.schedule_once(
        Duration::from_secs(30),
        move || async move {
            println!("客户端 {} 心跳超时", client_id);
            disconnect_client(client_id).await;
        }
    ).await?;
}

// 统一处理超时
let mut rx = service.take_receiver().unwrap();
while let Some(task_id) = rx.recv().await {
    println!("心跳检测超时: {:?}", task_id);
}

4. 缓存过期

use std::collections::HashMap;
use std::sync::Arc;
use parking_lot::Mutex;

struct CacheManager {
    timer: TimerWheel,
    cache: Arc<Mutex<HashMap<String, String>>>,
}

impl CacheManager {
    async fn set(&self, key: String, value: String, ttl: Duration) {
        // 存储到缓存
        self.cache.lock().insert(key.clone(), value);
        
        // 设置过期定时器
        let cache = Arc::clone(&self.cache);
        self.timer.schedule_once(ttl, move || {
            let cache = Arc::clone(&cache);
            let key = key.clone();
            async move {
                cache.lock().remove(&key);
                println!("缓存键 {} 已过期", key);
            }
        }).await.ok();
    }
}

5. 定时任务调度

// 每个任务在特定时间后执行
let tasks = vec![
    ("任务A", Duration::from_secs(10)),
    ("任务B", Duration::from_secs(30)),
    ("任务C", Duration::from_secs(60)),
];

let callbacks: Vec<_> = tasks.into_iter()
    .map(|(name, delay)| {
        (delay, move || async move {
            println!("执行定时任务: {}", name);
            execute_scheduled_task(name).await;
        })
    })
    .collect();

timer.schedule_once_batch(callbacks).await?;

6. 游戏服务器 Buff 系统

// 游戏角色的 buff 效果管理
async fn apply_buff(
    timer: &TimerWheel,
    player_id: u64,
    buff_type: BuffType,
    duration: Duration
) -> Result<(), TimerError> {
    println!("玩家 {} 获得 buff: {:?}", player_id, buff_type);
    
    timer.schedule_once(duration, move || async move {
        println!("玩家 {} 的 buff {:?} 已失效", player_id, buff_type);
        remove_buff(player_id, buff_type).await;
    }).await?;
    
    Ok(())
}

依赖项

核心依赖

依赖 版本 用途
tokio 1.48+ 异步运行时,提供异步任务调度和执行
parking_lot 0.12 高性能锁实现,比标准库 Mutex 更快
rustc-hash 2.1 FxHashMap 实现,减少哈希冲突
futures 0.3 异步工具和抽象
smallvec 1.15 小型向量优化,减少堆分配

开发依赖

依赖 版本 用途
criterion 0.7 性能基准测试框架

贡献指南

欢迎贡献代码、报告问题或提出建议!

报告问题

如果您发现 bug 或有功能请求,请在 GitHub 上创建 issue,包含:

  1. 问题描述
  2. 复现步骤
  3. 预期行为和实际行为
  4. 环境信息(Rust 版本、操作系统等)
  5. 相关代码片段或最小复现示例

提交 Pull Request

  1. Fork 本项目
  2. 创建功能分支:git checkout -b feature/my-feature
  3. 编写代码并确保通过测试:cargo test
  4. 运行 clippy 检查:cargo clippy
  5. 格式化代码:cargo fmt
  6. 提交更改:git commit -am 'Add my feature'
  7. 推送到分支:git push origin feature/my-feature
  8. 创建 Pull Request

代码风格

  • 遵循 Rust 官方代码风格指南
  • 使用 cargo fmt 格式化代码
  • 使用 cargo clippy 检查代码质量
  • 为公共 API 编写文档注释
  • 为新功能添加测试用例

开发环境设置

# 克隆仓库
git clone https://github.com/ShaoG-R/kestrel-protocol-timer.git
cd kestrel-protocol-timer

# 运行测试
cargo test

# 运行基准测试
cargo bench

# 检查代码
cargo clippy

# 格式化代码
cargo fmt

许可证

本项目采用 MIT 或 Apache-2.0 双许可证。

您可以选择以下任一许可证使用本项目:

致谢和参考

时间轮算法

时间轮算法最早由 George Varghese 和 Tony Lauck 在论文 "Hashed and Hierarchical Timing Wheels: Data Structures for the Efficient Implementation of a Timer Facility" (SOSP '87) 中提出。

相关项目

灵感来源

  • Kafka 的时间轮实现
  • Netty 的 HashedWheelTimer
  • Linux 内核的定时器实现

如有问题或建议,欢迎提交 issue 或 PR!