rslock - RedLock for Redis in Rust

Crates.io ![Docs badge]

This is an implementation of Redlock, the distributed locking mechanism built on top of Redis.

It is a fork of the existing redlock-rs with additional features like async Redis and the RedLock extend feature.

Build

cargo build --release

Usage

```rust 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 Locks

It should be noted that "extending" RedLocks actually just renews them. For example, when you extend a 1000ms lock after 500ms have elapsed by another 1000ms, the lock will live for a total of 1500ms. It does not add additional time the the existing lock. This is how it was implemented in the Node.js version of RedLock and it will remain that way to be consistent. See the extend script.

Tests

Run tests with:

cargo test

Contribute

If you find bugs or want to help otherwise, please open an issue.

License

BSD. See LICENSE.