redis_getlock 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e211a307e1814231fd3bff20fe5a435c4086bd4b
-  data.tar.gz: 8eff81ba4ddc1bdbd434cc730c676684b3b6a24f
+  metadata.gz: 6fc0883b1b090a5d98583474945925da5f32a383
+  data.tar.gz: e6763a3272de61da92bd839d2b6a5034e56ed874
 SHA512:
-  metadata.gz: c5066ccec8e8b53c5b8f8a58c0d80740921a7627431918ed2a92d3533620c6fa1787c72d3aeaa7b6f0ce6899b434ddd236b14ee1c3c87435e357b1890040bf34
-  data.tar.gz: 77b1d0ba859c9e7b0dd04ee59473c9aefc2e785ca03a131902c342da4c6418eee9646f7b0626b38e2bc821ad8ca6560a8c7f087cae1f10be4655d9f20a327e6f
+  metadata.gz: cfa994d572aa72130f2749cbceae0e148e6ed8aab2f7ca9c53fbd8d3525abd1a0f9dfdfc63474297f79e331a7ea92a802c433f9caca4ba26afd9a13ff7f11a09
+  data.tar.gz: 2f7fe9f173577b854789821ddb3d739e078e5e210e5ca49d7c7d716ba22772deceb5a1947609c8a3c1f8dcb40126726f5df45532811381b5e6de9b86c40e13c9

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.3.2 (2016-08-29)
+
+Enhancements:
+
+* Add #try_lock
+
 # 0.3.1 (2016-08-29)
 
 Enhancements:

data/README.md

@@ -84,6 +84,8 @@ Similarly with ruby standard library [mutex](https://ruby-doc.org/core-2.2.0/Mut
   * Releases the lock. Returns true if successfully released a lock
 * self_locked?
   * Returns true if this lock is currently held by myself.
+* try_lock
+  * Attempts to grab the lock and returns immediately without waits. Returns true if successfully acquired a lock  
 
 Options of `RedisGetlock.new` are:
 

data/bin/try_lock

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redis_getlock"
+require 'logger'
+require 'optparse'
+
+opts = {
+  kill: false
+}
+OptionParser.new.tap {|op|
+  op.on('--kill') {|v|
+    opts[:kill] = true
+  }
+  op.parse(ARGV)
+}
+
+if opts[:kill]
+  trap('INT') do
+    exit!
+  end
+end
+
+mutex = RedisGetlock.new(
+  redis: Redis.new, key: 'redis_getlock', logger: Logger.new(STDOUT),
+  timeout: -1,
+)
+if mutex.try_lock
+  loop do
+    puts "locked?:#{mutex.locked?} self_locked?:#{mutex.self_locked?}"
+    sleep 1
+  end
+else
+  puts 'exit'
+end

data/lib/redis_getlock/version.rb

@@ -1,3 +1,3 @@
 class RedisGetlock
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/lib/redis_getlock.rb

@@ -6,7 +6,7 @@ require 'json'
 class RedisGetlock
   attr_reader :redis, :key, :logger, :timeout, :expire, :interval, :uuid
 
-  TIMEOUT = -1
+  TIMEOUT = -1 # infinity
   EXPIRE = 2
   INTERVAL = 1
 
@@ -40,6 +40,23 @@ class RedisGetlock
     end
   end
 
+  def try_lock
+    if set_options_available?
+      locked = try_lock_with_set_options
+    else
+      locked = try_lock_without_set_options
+    end
+    @thr.terminate if @thr and @thr.alive?
+    if locked
+      @thr = Thread.new(&method(:keeplock))
+      logger.info { "#{log_head}Acquired a redis lock '#{key}'" } if logger
+      true
+    else
+      logger.info { "#{log_head}A redis lock is already acquired '#{key}'" } if logger
+      false
+    end
+  end
+
   def unlock
     @thr.terminate if @thr and @thr.alive?
     if self_locked?
@@ -66,7 +83,7 @@ class RedisGetlock
   def synchronize(&block)
     raise LockError unless lock
     begin
-      return yield
+      yield
     ensure
       unlock
     end
@@ -89,32 +106,51 @@ class RedisGetlock
   def lock_with_set_options
     started = Time.now.to_f
     loop do
-      current = Time.now.to_f
-      payload = {uuid: uuid, expire_at: (current + expire).to_s}.to_json
-      return true if redis.set(key, payload, {nx: true, ex: expire}) # key does not exist
-      return false if timeout >= 0 and (current - started) >= timeout
+      locked = try_lock_with_set_options
+      return true if locked
+      break if timeout >= 0 and (Time.now.to_f - started) >= timeout
       sleep interval
     end
+    false
   end
 
   # redis < 2.6.12
   # ref. http://redis.io/commands/setnx
   def lock_without_set_options
+    started = Time.now.to_f
     loop do
-      current = Time.now.to_f
-      payload = {uuid: uuid, expire_at: (current + expire).to_s}.to_json
-      if redis.setnx(key, payload) # key does not exist
-        redis.expire(key, expire)
-        return true # acquire lock
-      end
-      previous = JSON.parse(redis.get(key))
-      if previous['expire_at'].to_f < current # key exists, but previous
-        compared = redis.getset(key, paylod)
-        return true if previous['expire_at'] == compared['expire_at'] # acquire lock
-      end
-      return false if timeout >= 0 and (current - started) >= timeout
+      locked = try_lock_without_set_options
+      return true if locked
+      break if timeout >= 0 and (Time.now.to_f - started) >= timeout
       sleep interval
     end
+    false
+  end
+
+  # redis >= 2.6.12
+  # ref. http://redis.io/commands/set
+  def try_lock_with_set_options
+    current = Time.now.to_f
+    payload = {uuid: uuid, expire_at: (current + expire).to_s}.to_json
+    return true if redis.set(key, payload, {nx: true, ex: expire}) # key does not exist
+    false
+  end
+
+  # redis < 2.6.12
+  # ref. http://redis.io/commands/setnx
+  def try_lock_without_set_options
+    current = Time.now.to_f
+    payload = {uuid: uuid, expire_at: (current + expire).to_s}.to_json
+    if redis.setnx(key, payload) # key does not exist
+      redis.expire(key, expire)
+      return true # acquire lock
+    end
+    previous = JSON.parse(redis.get(key))
+    if previous['expire_at'].to_f < current # key exists, but previous
+      compared = redis.getset(key, paylod)
+      return true if previous['expire_at'] == compared['expire_at'] # acquire lock
+    end
+    false
   end
 
   def keeplock

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_getlock
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-28 00:00:00.000000000 Z
+date: 2016-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -84,8 +84,9 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/lock
 - bin/setup
-- bin/try
+- bin/try_lock
 - lib/redis_getlock.rb
 - lib/redis_getlock/version.rb
 - redis_getlock.gemspec