mysql_getlock 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88dca1f22a91ecae47c4cc919cf9ebbb7469cb7e
-  data.tar.gz: 63f0e9adfdd7c2901f69c45fbd2518569397e461
+  metadata.gz: 1280092349ef7ab3f0ca7f8bc3c8a72f3d69f41b
+  data.tar.gz: b796df17269c811dbc37c7cb808dbb7740866201
 SHA512:
-  metadata.gz: e6adaa01efcd040b6ae82fe31332ebf28c9558d31ec3be4d690c8858b1f5aab447e130bef82b70dd7621fcbd17913f36645e4d2b2a001be54f72033c11e527d5
-  data.tar.gz: 374c9497d072e02722d2883acfe865cbb7eaf46f15024aba43d3e955f7471e11b5beffa304c63a2c2eb2de12cab5988cf39c9de9a66870f777c1839e6bf5616c
+  metadata.gz: 9d1ded0d17085cfbddb1adc5bab4d9b7c6f736a112fa38ba6a1f27d7b83df52a3cf8dc2a5e028cafdb61f5e0ffede99ff96cd5bc281923b8391f1f59692bb195
+  data.tar.gz: e1928bc99ee3e1a9994bdae57de7066c49e9d5642fc4f5f3cf264e544947ad40bcc6db10ecaac26d2f36e456fb51b5c4ff803109e16ce112d277e176fb6d4733

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.2.3 (2016-08-31)
+
+Enhancements:
+
+* Add #try_lock
+
 # 0.2.2 (2016-08-29)
 
 Enhancements:

data/README.md

@@ -59,6 +59,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 `MysqlGetlock.new` are:
 

data/bin/try_lock

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mysql_getlock"
+require 'logger'
+
+mysql2 = Mysql2::Client.new
+mutex = MysqlGetlock.new(
+  mysql2: mysql2, key: 'mysql_getlock', logger: Logger.new(STDOUT), timeout: -1,
+)
+if mutex.try_lock
+  loop do
+    puts mutex.locked?
+    sleep 1
+  end
+else
+  puts 'exit'
+end

data/lib/mysql_getlock.rb

@@ -27,26 +27,11 @@ class MysqlGetlock
   end
 
   def lock
-    if !multiple_lockable? and (current_session_key and current_session_key != key)
-      raise Error, "get_lock() is already issued in the same connection for '#{current_session_key}'"
-    end
+    _lock(@timeout)
+  end
 
-    logger.info { "#{log_head}Wait #{timeout < -1 ? '' : "#{timeout} sec "}to acquire a mysql lock '#{key}'" } if logger
-    results = mysql2.query(%Q[select get_lock('#{key}', #{timeout})], as: :array)
-    case results.to_a.first.first
-    when 1
-      logger.info { "#{log_head}Acquired a mysql lock '#{key}'" } if logger
-      set_current_session_key(key)
-      true
-    when 0
-      logger.info { "#{log_head}Timeout to acquire a mysql lock '#{key}'" } if logger
-      release_current_session_key
-      false
-    else # nil
-      logger.info { "#{log_head}Unknown Error to acquire a mysql lock '#{key}'" } if logger
-      release_current_session_key
-      false
-    end
+  def try_lock
+    _lock(0)
   end
 
   def unlock
@@ -95,6 +80,38 @@ class MysqlGetlock
 
   private
 
+  def _lock(timeout)
+    if !multiple_lockable? and (current_session_key and current_session_key != key)
+      raise Error, "get_lock() is already issued in the same connection for '#{current_session_key}'"
+    end
+
+    if timeout == 0 # try_lock
+      # no wait
+    else
+      logger.info { "#{log_head}Wait #{timeout < -1 ? '' : "#{timeout} sec "}to acquire a mysql lock '#{key}'" } if logger
+    end
+
+    results = mysql2.query(%Q[select get_lock('#{key}', #{timeout})], as: :array)
+    case results.to_a.first.first
+    when 1
+      logger.info { "#{log_head}Acquired a mysql lock '#{key}'" } if logger
+      set_current_session_key(key)
+      true
+    when 0
+      if timeout == 0 # try_lock
+        logger.info { "#{log_head}A mysql lock is already acquired by the other session '#{key}'" } if logger
+      else
+        logger.info { "#{log_head}Timeout to acquire a mysql lock '#{key}'" } if logger
+      end
+      release_current_session_key
+      false
+    else # nil
+      logger.info { "#{log_head}Unknown Error to acquire a mysql lock '#{key}'" } if logger
+      release_current_session_key
+      false
+    end
+  end
+
   def set_timeout(timeout)
     if infinite_timeoutable?
       @timeout = timeout

data/lib/mysql_getlock/version.rb

@@ -1,3 +1,3 @@
 class MysqlGetlock
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mysql_getlock
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-29 00:00:00.000000000 Z
+date: 2016-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mysql2
@@ -85,6 +85,7 @@ files:
 - bin/console
 - bin/setup
 - bin/try
+- bin/try_lock
 - lib/mysql_getlock.rb
 - lib/mysql_getlock/version.rb
 - mysql_getlock.gemspec