Class: ActiveRecord::Queue

Inherits:
Object
  • Object
show all
Defined in:
lib/active_record/queue.rb

Overview

Threadsafe, fair, FIFO queue. Meant to be used by ConnectionPool with which it shares a Monitor. But could be a generic Queue.

Instance Method Summary collapse

Constructor Details

#initialize(lock = Monitor.new) ⇒ Queue

Returns a new instance of Queue.



12
13
14
15
16
17
 
# File 'lib/active_record/queue.rb', line 12

def initialize(lock = Monitor.new)
  @lock = lock
  @cond = @lock.new_cond
  @num_waiting = 0
  @queue = []
end

Instance Method Details

#add(element) ⇒ Object

Add element to the queue. Never blocks.



35
36
37
38
39
40
 
# File 'lib/active_record/queue.rb', line 35

def add(element)
  synchronize do
    @queue.push element
    @cond.signal
  end
end

#any_waiting? ⇒ Boolean

Test if any threads are currently waiting on the queue.

Returns:

  • (Boolean) 


20
21
22
23
24
 
# File 'lib/active_record/queue.rb', line 20

def any_waiting?
  synchronize do
    @num_waiting > 0
  end
end

#clear ⇒ Object

Remove all elements from the queue.



50
51
52
53
54
 
# File 'lib/active_record/queue.rb', line 50

def clear
  synchronize do
    @queue.clear
  end
end

#delete(element) ⇒ Object

If element is in the queue, remove and return it, or nil.



43
44
45
46
47
 
# File 'lib/active_record/queue.rb', line 43

def delete(element)
  synchronize do
    @queue.delete(element)
  end
end

#num_waiting ⇒ Object

Return the number of threads currently waiting on this queue.



28
29
30
31
32
 
# File 'lib/active_record/queue.rb', line 28

def num_waiting
  synchronize do
    @num_waiting
  end
end

#poll(timeout = nil) ⇒ Object

Remove the head of the queue.

If timeout is not given, remove and return the head the queue if the number of available elements is strictly greater than the number of threads currently waiting (that is, don’t jump ahead in line). Otherwise, return nil.

If timeout is given, block if it there is no element available, waiting up to timeout seconds for an element to become available.

Raises:

  • ConnectionTimeoutError if timeout is given and no element

becomes available after timeout seconds,



70
71
72
73
74
75
76
77
78
 
# File 'lib/active_record/queue.rb', line 70

def poll(timeout = nil)
  synchronize do
    if timeout
      no_wait_poll || wait_poll(timeout)
    else
      no_wait_poll
    end
  end
end