This is an implementation of Redlock, the distributed locking mechanism built on top of Redis.
- Lock extending
- Async runtime support (async-std and tokio)
- Async redis
cargo add rslock
Note
The default
feature of this crate will provide async-std. You may optionally use tokio by supplying the tokio-comp
feature flag when installing, but tokio has limitations that will not grant access to some parts of the API (read more here).
cargo build --release
use rslock::LockManager;
#[tokio::main]
async fn main() {
let rl = LockManager::new(vec![
"redis://127.0.0.1:6380/",
"redis://127.0.0.1:6381/",
"redis://127.0.0.1:6382/",
]);
let lock;
loop {
// Create the lock
if let Ok(l) = rl.lock("mutex".as_bytes(), 1000).await {
lock = l;
break;
}
}
// Extend the lock
match rl.extend(&lock, 1000).await {
Ok(_) => println!("lock extended!"),
Err(_) => println!("lock couldn't be extended"),
}
// Unlock the lock
rl.unlock(&lock).await;
}
Extending a lock effectively renews its duration instead of adding extra time to it. For instance, if a 1000ms lock is extended by 1000ms after 500ms pass, it will only last for a total of 1500ms, not 2000ms. This approach is consistent with the Node.js Redlock implementation. See the extend script.
Run tests with:
cargo test
If you find bugs or want to help otherwise, please open an issue.
BSD. See LICENSE.