Class: ActiveRecord::ConnectionAdapters::ConnectionPool::Queue

Inherits:
Object
  • Object
show all
Defined in:
activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb

Overview

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

The Queue in stdlib’s ‘thread’ could replace this class except stdlib’s doesn’t support waiting with a timeout.

Direct Known Subclasses

ConnectionLeasingQueue

Instance Method Summary collapse

Constructor Details

#initialize(lock = Monitor.new) ⇒ Queue 



91
92
93
94
95
96
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb', line 91

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.



114
115
116
117
118
119
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb', line 114

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.



99
100
101
102
103
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb', line 99

def any_waiting?
  synchronize do
    @num_waiting > 0
  end
end

#clear ⇒ Object

Remove all elements from the queue.



129
130
131
132
133
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb', line 129

def clear
  synchronize do
    @queue.clear
  end
end

#delete(element) ⇒ Object

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



122
123
124
125
126
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb', line 122

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

#num_waiting ⇒ Object

Returns the number of threads currently waiting on this queue.



107
108
109
110
111
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb', line 107

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 there is no element available, waiting up to timeout seconds for an element to become available.

Raises:

  • ActiveRecord::ConnectionTimeoutError if timeout is given and no element

becomes available within timeout seconds,



149
150
151
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb', line 149

def poll(timeout = nil)
  synchronize { internal_poll(timeout) }
end