expire_map

Api Doc

English | 中文说明

English Readme

Use

expire_map : High concurrency dictionary supporting a maximum of 256 cycles timeout (internally implemented using dashmap).

Also, I implement RetryMap based on ExpireMap and can be used for network request timeouts and retries.

RetryMap usage demo

→ examples/main.rs

```rust use std::{net::SocketAddrV4, time::Duration};

use anyhow::Result; use asyncstd::task::{blockon, sleep, spawn}; use expire_map::{Caller, RetryMap};

[derive(Debug)]

struct Msg { msg: Box<[u8]>, }

[derive(Debug, Copy, Clone, Eq, Hash, PartialEq)]

struct Task { addr: SocketAddrV4, id: u16, }

impl Caller for Msg { fn ttl() -> u8 { 2 // 2 seconds timeout } fn call(&mut self, task: &Task) { let cmd = format!("{} {}#{} {:?}", "call", task.addr, task.id, &self.msg); dbg!(cmd); }

fn fail(&mut self, task: &Task) { let cmd = format!("{} {}#{} {:?}", "fail", task.addr, task.id, &self.msg); dbg!(cmd); } }

fn main() -> Result<()> { let msg = Msg { msg: Box::from(&[1, 2, 3][..]), };

let task = Task { id: 12345, addr: "223.5.5.5:53".parse()?, };

let retrytimes = 3; // 重试次数是3次 let retrymap = RetryMap::new();

let expireer = retry_map.clone();

let handle = spawn(async move { let mut doexpire = 0; loop { sleep(Duration::fromsecs(1)).await; expireer.doexpire(); doexpire += 1; let exist = expireer.get(&task).issome(); println!("{} {}", doexpire, exist); } });

// will run call() when insert retrymap.insert(task, msg, retrytimes);

retrymap.renew(task, 5); //dbg!(retrymap.get(&task).unwrap().value()); //dbg!(retrymap.getmut(&task).unwrap().key()); //retry_map.remove(task);

block_on(handle); Ok(()) } ```

Output

→ out.txt

``txt cargo run --example main Compiling expire_map v0.0.13 (/Users/z/rmw/expire_map) Finished dev [unoptimized + debuginfo] target(s) in 1.37s Running/Users/z/rmw/expire_map/target/debug/examples/main`

[examples/main.rs:24] cmd = "call 223.5.5.5:53#12345 [1, 2, 3]" 1 true 2 true 3 true 4 true 5 true [examples/main.rs:24] cmd = "call 223.5.5.5:53#12345 [1, 2, 3]" 6 true 7 true [examples/main.rs:24] cmd = "call 223.5.5.5:53#12345 [1, 2, 3]" 8 true 9 true [examples/main.rs:24] cmd = "call 223.5.5.5:53#12345 [1, 2, 3]" [examples/main.rs:29] cmd = "fail 223.5.5.5:53#12345 [1, 2, 3]" 10 false 11 false 12 false 13 false ```

ExpireMap usage demo

The use of ExpireMap can be seen in the RetryMap implementation

→ src/retry.rs

```rust use std::{fmt::Debug, ops::Deref};

use crate::{expire_map::Key, ExpireMap, OnExpire};

/* btree 超时时间 id 重试函数 重试次数 失败

*/

pub trait Caller { /// Time-To-Live fn ttl() -> u8; fn call(&mut self, key: &K); fn fail(&mut self, key: &K); }

[derive(Debug, Default)]

pub struct Retry { n: u8, caller: C, }

impl> OnExpire for Retry { fn onexpire(&mut self, key: &K) -> u8 { self.caller.call(key); let n = self.n.wrappingsub(1); if n == 0 { self.caller.fail(key); 0 } else { self.n = n; C::ttl() } } }

[derive(Debug, Default)]

pub struct RetryMap + Debug> { pub expire: ExpireMap>, }

impl + Debug> Clone for RetryMap { fn clone(&self) -> Self { Self { expire: self.expire.clone(), } } }

impl + Debug> RetryMap { pub fn new() -> Self { Self { expire: ExpireMap::new(), } }

pub fn insert(&self, key: K, mut caller: C, retry: u8) { caller.call(&key); self .expire .insert(key, Retry { n: retry, caller }, C::ttl()); } }

impl + Debug> Deref for RetryMap { type Target = ExpireMap>; fn deref(&self) -> &::Target { &self.expire } } ```

About

This project is part of rmw.link Code Project

rmw.link logo

中文说明

expire_map : 最大支持 256 个周期超时的高并发字典（内部使用 dashmap 实现）。

同时，基于 ExpireMap 实现了 RetryMap，可以用于网络请求超时和重试。

RetryMap 使用演示

→ examples/main.rs

```rust use std::{net::SocketAddrV4, time::Duration};

use anyhow::Result; use asyncstd::task::{blockon, sleep, spawn}; use expire_map::{Caller, RetryMap};

[derive(Debug)]

struct Msg { msg: Box<[u8]>, }

[derive(Debug, Copy, Clone, Eq, Hash, PartialEq)]

struct Task { addr: SocketAddrV4, id: u16, }

impl Caller for Msg { fn ttl() -> u8 { 2 // 2 seconds timeout } fn call(&mut self, task: &Task) { let cmd = format!("{} {}#{} {:?}", "call", task.addr, task.id, &self.msg); dbg!(cmd); }

fn fail(&mut self, task: &Task) { let cmd = format!("{} {}#{} {:?}", "fail", task.addr, task.id, &self.msg); dbg!(cmd); } }

fn main() -> Result<()> { let msg = Msg { msg: Box::from(&[1, 2, 3][..]), };

let task = Task { id: 12345, addr: "223.5.5.5:53".parse()?, };

let retrytimes = 3; // 重试次数是3次 let retrymap = RetryMap::new();

let expireer = retry_map.clone();

let handle = spawn(async move { let mut doexpire = 0; loop { sleep(Duration::fromsecs(1)).await; expireer.doexpire(); doexpire += 1; let exist = expireer.get(&task).issome(); println!("{} {}", doexpire, exist); } });

// will run call() when insert retrymap.insert(task, msg, retrytimes);

retrymap.renew(task, 5); //dbg!(retrymap.get(&task).unwrap().value()); //dbg!(retrymap.getmut(&task).unwrap().key()); //retry_map.remove(task);

block_on(handle); Ok(()) } ```

运行输出

→ out.txt

``txt cargo run --example main Compiling expire_map v0.0.13 (/Users/z/rmw/expire_map) Finished dev [unoptimized + debuginfo] target(s) in 1.37s Running/Users/z/rmw/expire_map/target/debug/examples/main`

[examples/main.rs:24] cmd = "call 223.5.5.5:53#12345 [1, 2, 3]" 1 true 2 true 3 true 4 true 5 true [examples/main.rs:24] cmd = "call 223.5.5.5:53#12345 [1, 2, 3]" 6 true 7 true [examples/main.rs:24] cmd = "call 223.5.5.5:53#12345 [1, 2, 3]" 8 true 9 true [examples/main.rs:24] cmd = "call 223.5.5.5:53#12345 [1, 2, 3]" [examples/main.rs:29] cmd = "fail 223.5.5.5:53#12345 [1, 2, 3]" 10 false 11 false 12 false 13 false ```

ExpireMap 使用演示

ExpireMap 的使用可以参见 RetryMap 的实现

→ src/retry.rs

```rust use std::{fmt::Debug, ops::Deref};

use crate::{expire_map::Key, ExpireMap, OnExpire};

/* btree 超时时间 id 重试函数 重试次数 失败

*/

pub trait Caller { /// Time-To-Live fn ttl() -> u8; fn call(&mut self, key: &K); fn fail(&mut self, key: &K); }

[derive(Debug, Default)]

pub struct Retry { n: u8, caller: C, }

impl> OnExpire for Retry { fn onexpire(&mut self, key: &K) -> u8 { self.caller.call(key); let n = self.n.wrappingsub(1); if n == 0 { self.caller.fail(key); 0 } else { self.n = n; C::ttl() } } }

[derive(Debug, Default)]

pub struct RetryMap + Debug> { pub expire: ExpireMap>, }

impl + Debug> Clone for RetryMap { fn clone(&self) -> Self { Self { expire: self.expire.clone(), } } }

impl + Debug> RetryMap { pub fn new() -> Self { Self { expire: ExpireMap::new(), } }

pub fn insert(&self, key: K, mut caller: C, retry: u8) { caller.call(&key); self .expire .insert(key, Retry { n: retry, caller }, C::ttl()); } }

impl + Debug> Deref for RetryMap { type Target = ExpireMap>; fn deref(&self) -> &::Target { &self.expire } } ```

关于

本项目隶属于 人民网络 (rmw.link) 代码计划。

人民网络海报