Class: Threach::Queue

Inherits:

ArrayBlockingQueue

• Object
• ArrayBlockingQueue
• Threach::Queue

Defined in:

lib/jruby_threach.rb

Overview

An ArrayBlockingQueue with reasonable defaults for timeouts.

Constant Summary

MS =

TimeUnit::MILLISECONDS

Instance Method Summary

• #initialize(size = 5, timeout_in_ms = 5) ⇒ Queue constructor

  Create a new queue.

• #pop ⇒ Object^?

  Pop an object ouf of the queue.

• #push(obj) ⇒ Boolean

  Try to add an object to the queue.

Constructor Details

#initialize(size = 5, timeout_in_ms = 5) ⇒ Queue

Create a new queue

Parameters:

• size (Integer) (defaults to: 5) —

  The size of the queue

• timeout_in_ms (Integer) (defaults to: 5) —

  How long to wait when trying to push or pop

# File 'lib/jruby_threach.rb', line 30

def initialize (size=5, timeout_in_ms = 5)
  super(size)
  @timeout = timeout_in_ms
end

Instance Method Details

#pop ⇒ Object^?

Pop an object ouf of the queue

Returns:

• (Object, nil) —

  nil if it times out; the popped object otherwise

# File 'lib/jruby_threach.rb', line 44

def pop
  self.poll @timeout, MS
end

#push(obj) ⇒ Boolean

Try to add an object to the queue

Parameters:

• obj (Object) —

  The object to push

Returns:

• (Boolean) —

  true on success, false on timeout

# File 'lib/jruby_threach.rb', line 38

def push obj
  self.offer obj, @timeout, MS
end