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, LIFO queue. Meant to be used by ConnectionPool with which it shares a Monitor.

Direct Known Subclasses

ConnectionLeasingQueue

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(lock = Monitor.new) ⇒ Queue

Returns a new instance of Queue.



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

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

Instance Attribute Details

#num_waiting ⇒ Object (readonly)

Returns the number of threads currently waiting on this queue.



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

def num_waiting
  synchronize do
    @num_waiting
  end
end

Instance Method Details

#add(element) ⇒ Object

Add element to the queue. Never blocks.



132
133
134
135
136
137
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb', line 132

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) 


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

def any_waiting?
  synchronize do
    @num_waiting > 0
  end
end

#clear ⇒ Object

Remove all elements from the queue.



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

def clear
  synchronize do
    @queue.clear
  end
end

#delete(element) ⇒ Object

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



140
141
142
143
144
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb', line 140

def delete(element)
  synchronize do
    @queue.delete(element)
  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,



167
168
169
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb', line 167

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