Struct redlock_async::RedLock

pub struct RedLock {
    pub servers: Vec<Client>,
    /* private fields */
}

The lock manager.

Implements the necessary functionality to acquire and release locks and handles the Redis connections.

Fields

servers: Vec<Client>

List of all Redis clients

Implementations

impl RedLock

pub fn new<T: AsRef<str> + IntoConnectionInfo>(uris: Vec<T>) -> RedLock

Create a new lock manager instance, defined by the given Redis connection uris. Quorum is defined to be N/2+1, with N being the number of given Redis instances.

Sample URI: "redis://127.0.0.1:6379"

pub fn get_unique_lock_id(&self) -> Result<Vec<u8>>

Get 20 random bytes from /dev/urandom.

pub fn set_retry(&mut self, count: u32, delay: u32)

Set retry count and retry delay.

Retry count defaults to 3. Retry delay defaults to 200.

pub async fn unlock(&self, lock: &Lock<'_>)

Unlock the given lock.

Unlock is best effort. It will simply try to contact all instances and remove the key.

pub async fn lock(
    &self,
    resource: &[u8],
    ttl: usize
) -> Result<Lock<'_>, RedLockError>

Acquire the lock for the given resource and the requested TTL.

If it succeeds, a Lock instance is returned, including the value and the validity time

If it fails. None is returned. A user should retry after a short wait time.

pub async fn acquire(&self, resource: &[u8], ttl: usize) -> RedLockGuard<'_>

Trait Implementations

impl Clone for RedLock

fn clone(&self) -> RedLock

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RedLock

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.