This is an implementation of Redlock, the distributed locking mechanism built on top of Redis.
Warning
Before release 1.0.0, this crate will have breaking changes between minor versions. You can upgrade to patch versions without worrying about breaking changes.
- Lock extending
- Async runtime support (async-std and tokio)
- Async redis
cargo add rslockNote
The default feature of this crate will provide async-std. You may optionally use tokio by supplying the tokio-comp feature flag when installing.
cargo build --release
use rslock::LockManager;
use std::time::Duration;
#[tokio::main]
async fn main() {
// Define Redis URIs
let uris = vec![
"redis://127.0.0.1:6380/",
"redis://127.0.0.1:6381/",
"redis://127.0.0.1:6382/",
];
// Initialize the LockManager using `new`
let rl = LockManager::new(uris);
// Acquire a lock
let lock = loop {
if let Ok(lock) = rl
.lock("mutex".as_bytes(), Duration::from_millis(1000))
.await
{
break lock;
}
};
println!("Lock acquired!");
// Extend the lock
if rl.extend(&lock, Duration::from_millis(1000)).await.is_ok() {
println!("Lock extended!");
} else {
println!("Failed to extend the lock.");
}
// Unlock the lock
rl.unlock(&lock).await;
println!("Lock released!");
}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.
Make sure you have Docker running since all tests use testcontainers. Run tests with:
cargo test --all-features
Start the redis servers mentioned in the example code:
docker compose -f examples/docker-compose.yml up -dRun the examples:
cargo run --example basic
cargo run --example shared_lock
cargo run --example from_clientsStop the redis servers:
docker compose -f examples/docker-compose.yml downIf you find bugs or want to help otherwise, please open an issue.
BSD. See LICENSE.