priority_mutex 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    N2E0OTMwYzJiYmE5M2E5Y2ZjYzhlZTlkZWVlOGZiNTc5YjA1M2IwNw==
+  data.tar.gz: !binary |-
+    YTJkYmZiYzM0YWE0YTg5NmE3Nzk0NGY4NTVkZGI5ZGQzZDRiMzY2NQ==
+SHA512:
+  metadata.gz: !binary |-
+    Mjc4YWYyZjI1ZDlkOWJkNmM4MWZkMzU5MDVhZjZmNzM1Mjk3ODVmZmIxOWY0
+    YjFkYjU3N2RlODIwODMwMmQ2MDVhMzA3M2RkZjNmOGY1MzAzMTNjN2QwYWU2
+    ZTM4Yzk1ZWVhNDBmMTI1Mzk0MDc2NDdkZjgxMWI5YjhiN2FmZjg=
+  data.tar.gz: !binary |-
+    ZTFhMTIzNmFmNzRmMjM2ZWQyMTM4MzQzMTQ4NDlhMWZmMTk2ODBlZjc3ZDVm
+    YjAwODYwMmY0MTE4OTVkYjEzMGIzMjgyZGFlYTliM2I3ZWE1OWI3ODhkNDg1
+    Y2ExMDQ3MzA2NmJlNWRiODI3YTYxNmY4OTIxNWFiMDViNDYzNDU=

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Mike Jarema
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,11 @@
+# priority_mutex [![Build Status](https://secure.travis-ci.org/mikejarema/priority_mutex.png)](http://travis-ci.org/mikejarema/priority_mutex)
+
+This gem implements a mutex which allows access to a shared resource as determined by a priority set by each requesting thread. Higher priority values mean higher priority.
+
+Using a PriorityMutex, you can now allow a high priority thread to "jump in line" for a mutex ahead of other lower priority threads. Note, this does not preempt the resource from a thread which is currently using the resource.
+
+
+
+## License & Notes
+
+The MIT License - Copyright (c) 2012 [Mike Jarema](http://mikejarema.com)

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/priority_mutex.rb

@@ -0,0 +1,84 @@
+=begin
+  Basically the PQueue manages the incoming requests from thread to access the shared resource,
+  and sorting these requests by priority such that the highest priority request gains access.
+
+  The Waiter helper class allows to pause and resume threads based on when the PQueue determines
+  they should have access to the shared resource.
+
+  The Waiter's pause/resume impementation is borrowed from http://stackoverflow.com/a/23767859/1001980,
+  and the queue is specifically used to preempt any race conditions that may arise from using a
+  Mutex, namely if a Waiter is #resume'd before #wait'ing.
+=end
+
+require 'pqueue'
+
+class PriorityMutex
+
+  class Waiter
+    attr_accessor :priority
+    def initialize(priority)
+      @priority = priority
+      @queue = Queue.new
+    end
+    def <=>(other)
+      self.priority <=> other.priority
+    end
+    def wait
+      @queue.deq
+      nil
+    end
+    def resume
+      @queue.enq :go
+    end
+  end
+
+  def initialize
+    @pq = PQueue.new
+    @pq_mutex = Mutex.new
+    @resource_active = false
+  end
+
+  def synchronize(priority = 0)
+    wait_for_resource_if_necessary(priority)
+    yield
+    release_resource
+  end
+
+private
+
+  def wait_for_resource_if_necessary(priority)
+    waiter = nil
+
+    @pq_mutex.synchronize do
+      if @resource_active
+        # So we'll need to wait, waiting happens _outside_ of this
+        # synchronization block to ensure that
+        waiter = Waiter.new(priority)
+        @pq.push(waiter)
+
+      else
+        @resource_active = true
+
+      end
+    end
+
+    if waiter
+      waiter.wait
+      @pq_mutex.synchronize { @resource_active = true }
+    end
+  end
+
+  def release_resource
+    next_waiter = nil
+
+    @pq_mutex.synchronize do
+      @resource_active = false
+      next_waiter = @pq.pop
+    end
+
+    if next_waiter
+      next_waiter.resume
+    end
+  end
+
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: priority_mutex
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mike Jarema
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: pqueue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Ruby gem implementing a Mutex which allows for preemptive queuing based
+  on priority.
+email: mike@jarema.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- VERSION
+- lib/priority_mutex.rb
+homepage: http://github.com/mikejarema/priority_mutex
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby gem implementing a Mutex which allows for preemptive queuing based on
+  priority.
+test_files: []