concurrent_queue 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e35cfa0497380e13950122758e7198a07491418a33ba46f23bc083b259d7f3fc
+  data.tar.gz: 8c6cc43aa25bb52767ef089a607ac3c329623d2946a3adbba124a89ef6a81817
+SHA512:
+  metadata.gz: 0e51954ec678f6981389192b6af826016339358218d618ad28b10613997f393fe56f3ef13a0fb97b9247015422a00272e2a75c42bc139d1463d493b9de467570
+  data.tar.gz: 4b67d6235c904a13b589bc54e6d7dee07d5221e66dad9e50f355ad62d8b099b1ea0731dd00f7d9cb2d45e3be4056c00295de41c2fad1d1319a4fa2e77d111e4a

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Rob Fors
+
+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,39 @@
+# ConcurrentQueue
+This is a Ruby gem that can be used to listen to multiple queues concurrently and return the value of the first queue to have an item pushed to it.
+
+# Install
+`gem install concurrent_queue`
+
+# Documentation
+You can use `ConcurrentQueue` instances as you would the core `Queue` instances. However, only the methods `pop`, `push` and `length` have been implemented. If you want to use this gem and you need more of the core methods feel free to submit a pull request or simply open an issue.
+
+The `ConcurrentQueue` class also offers a new method `pop`. Call this with a `ConcurrentQueue` instance or `Array` of `ConcurrentQueue` instances and it will listen to all the queues simultaneously. It will immediately return a pre existing item found in any of the queues if found, otherwise it will reutrn the first item pushed to any of the queues. Just like regular queues, the order of items in each individual queue is preserved, however, if a pre existing item is found it will be popped from the earliest queue in the array you provide.
+
+# Example
+```ruby
+require 'concurrent_queue'
+
+q1 = ConcurrentQueue.new
+q2 = ConcurrentQueue.new
+
+t1 = Thread.new do
+  puts ConcurrentQueue.pop([q1,q2])
+  sleep 2
+  puts ConcurrentQueue.pop([q1,q2])
+end
+
+t2 = Thread.new do
+  sleep 1
+  puts ConcurrentQueue.pop([q1,q2])
+  sleep 2
+  puts ConcurrentQueue.pop([q1,q2])
+end
+
+sleep 0.5
+q1.push(1)
+q1.push(2)
+q2.push(3)
+q2.push(4)
+t1.join
+t2.join
+```

data/lib/concurrent_queue.rb

@@ -0,0 +1,68 @@
+require 'thread'
+
+require_relative "concurrent_queue/listener.rb"
+
+class ConcurrentQueue
+  
+  def self.pop(arg)
+    arg = [arg] if arg.is_a?(ConcurrentQueue)
+    unless arg.is_a?(Array) && arg.all? { |queue| queue.is_a?(ConcurrentQueue) }
+      raise ArgumentError, 'must pass array of ConcurrentQueues'
+    end
+    queues = arg
+    listener = Listener.new
+    listener.pop(queues)
+  end
+  
+  def initialize
+    @listeners = []
+    @mutex = Mutex.new
+    @queue = Array.new
+  end
+  
+  def pop
+    self.class.pop(self)
+  end
+  
+  def push(item)
+    @mutex.synchronize do
+      @queue.push(item)
+      notify
+    end
+    nil
+  end
+  
+  def length
+    @mutex.synchronize { @queue.length }
+  end
+  
+  def add_listener(listener)
+    @mutex.synchronize do
+      @listeners << listener
+      notify if @queue.any?
+    end
+    nil
+  end
+  
+  def remove_listener(listener)
+    @mutex.synchronize do
+      @listeners.delete(listener)
+    end
+    nil
+  end
+  
+  private
+  
+  def notify
+    @listeners.each do |listener|
+      item = @queue.first
+      was_accepted = listener.send(item)
+      if was_accepted
+        @queue.shift
+        break
+      end
+    end
+    nil
+  end
+  
+end

data/lib/concurrent_queue/listener.rb

@@ -0,0 +1,40 @@
+class ConcurrentQueue
+  class Listener
+  
+    def initialize
+      @condition_variable = ConditionVariable.new
+      @mutex = Mutex.new
+      @popped = false
+      @item = nil
+    end
+    
+    def send(item)
+      @mutex.synchronize do
+        if @popped
+          return false
+        else
+          @item = item
+          @popped = true
+          @condition_variable.signal
+          return true
+        end
+      end
+    end
+    
+    def add_queue(queue)
+      raise unless queue.is_a?(ConcurrentQueue)
+      @queues << queue
+      nil
+    end
+    
+    def pop(queues)
+      queues.each { |queue| queue.add_listener(self) }
+      @mutex.synchronize do
+        @condition_variable.wait(@mutex) unless @popped
+      end
+      queues.each { |queue| queue.remove_listener(self) }
+      @item
+    end
+    
+  end
+end

data/test/test.rb

@@ -0,0 +1,84 @@
+require_relative "../lib/concurrent_queue.rb"
+
+Thread::abort_on_exception = true
+
+
+q1 = ConcurrentQueue.new
+q1.push(1)
+q1.push(2)
+raise unless q1.pop == 1
+raise unless q1.pop == 2
+
+
+q1 = ConcurrentQueue.new
+q1.push(1)
+q1.push(2)
+raise unless ConcurrentQueue.pop(q1) == 1
+raise unless ConcurrentQueue.pop([q1]) == 2
+
+
+q1 = ConcurrentQueue.new
+q2 = ConcurrentQueue.new
+q1.push(1)
+q1.push(2)
+q1.push(3)
+q2.push(4)
+q2.push(5)
+q2.push(6)
+raise unless ConcurrentQueue.pop([q1,q2]) == 1
+raise unless ConcurrentQueue.pop([q1,q2]) == 2
+raise unless ConcurrentQueue.pop([q1,q2]) == 3
+raise unless ConcurrentQueue.pop([q1,q2]) == 4
+raise unless ConcurrentQueue.pop([q1,q2]) == 5
+raise unless ConcurrentQueue.pop([q1,q2]) == 6
+
+
+q1 = ConcurrentQueue.new
+q2 = ConcurrentQueue.new
+q3 = ConcurrentQueue.new
+q1.push(1)
+q1.push(2)
+q2.push(3)
+q2.push(4)
+q3.push(5)
+q3.push(6)
+raise unless ConcurrentQueue.pop([q1,q2,q3]) == 1
+raise unless ConcurrentQueue.pop([q1,q2,q3]) == 2
+raise unless ConcurrentQueue.pop([q1,q2,q3]) == 3
+raise unless ConcurrentQueue.pop([q1,q2,q3]) == 4
+raise unless ConcurrentQueue.pop([q1,q2,q3]) == 5
+raise unless ConcurrentQueue.pop([q1,q2,q3]) == 6
+
+
+q1 = ConcurrentQueue.new
+q2 = ConcurrentQueue.new
+t = Thread.new do
+  raise unless ConcurrentQueue.pop([q1,q2]) == 1
+  raise unless ConcurrentQueue.pop([q1,q2]) == 2
+end
+sleep 1
+q1.push(1)
+q2.push(2)
+t.join
+
+q1 = ConcurrentQueue.new
+q2 = ConcurrentQueue.new
+t1 = Thread.new do
+  raise unless ConcurrentQueue.pop([q1,q2]) == 1
+  sleep 2
+  raise unless ConcurrentQueue.pop([q1,q2]) == 3
+end
+t2 = Thread.new do
+  sleep 1
+  raise unless ConcurrentQueue.pop([q1,q2]) == 2
+  sleep 2
+  raise unless ConcurrentQueue.pop([q1,q2]) == 4
+end
+q1.push(1)
+q1.push(2)
+q1.push(3)
+q1.push(4)
+t1.join
+t2.join
+
+puts 'test successful'

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: concurrent_queue
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Rob Fors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-02 00:00:00.000000000 Z
+dependencies: []
+description: Listen to multiple queues concurrently and return the value of the first
+  queue to have an item pushed to it.
+email: mail@robfors.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/concurrent_queue.rb
+- lib/concurrent_queue/listener.rb
+- test/test.rb
+homepage: https://github.com/robfors/concurrent_queue
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Listen to multiple queues concurrently.
+test_files: []