Module: RaceGuard::Distributed::LockStore

Included in:

MemoryLockStore, RedisLockStore

Defined in:

lib/race_guard/distributed/lock_store.rb

Overview

Pluggable mutual-exclusion backend for RaceGuard.distributed_once.

Implementations must be thread-safe for concurrent claim calls on the same key.

Instance Method Summary

• #claim(key:, token:, ttl:) ⇒ Boolean

  True if this caller now owns the lock.

• #release(key:, token:) ⇒ Boolean

  True if the key was deleted and matched token.

• #renew(key:, token:, ttl:) ⇒ Boolean

  True if TTL was extended for the same owner token.

Instance Method Details

#claim(key:, token:, ttl:) ⇒ Boolean

Returns true if this caller now owns the lock.

Parameters:

• key (String) —

  full Redis key or logical lock key

• token (String) —

  opaque owner token written on success

• ttl (Integer) —

  seconds until the lock expires if not released

Returns:

• (Boolean) —

  true if this caller now owns the lock

# File 'lib/race_guard/distributed/lock_store.rb', line 20

module LockStore
end

#release(key:, token:) ⇒ Boolean

Returns true if the key was deleted and matched token.

Returns:

• (Boolean) —

  true if the key was deleted and matched token

# File 'lib/race_guard/distributed/lock_store.rb', line 20

module LockStore
end

#renew(key:, token:, ttl:) ⇒ Boolean

Returns true if TTL was extended for the same owner token.

Returns:

• (Boolean) —

  true if TTL was extended for the same owner token

# File 'lib/race_guard/distributed/lock_store.rb', line 20

module LockStore
end