Threadsafe, fair, LIFO queue. Meant to be used by ConnectionPool
with which it shares a Monitor.
Methods
Class Public methods
new(lock = Monitor.new)
📝 Source code
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 96
def initialize(lock = Monitor.new)
@lock = lock
@cond = @lock.new_cond
@num_waiting = 0
@queue = []
end
🔎 See on GitHub
Instance Public methods
add(element)
Add element
to the queue. Never blocks.
📝 Source code
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 119
def add(element)
synchronize do
@queue.push element
@cond.signal
end
end
🔎 See on GitHub
any_waiting?()
Test if any threads are currently waiting on the queue.
📝 Source code
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 104
def any_waiting?
synchronize do
@num_waiting > 0
end
end
🔎 See on GitHub
clear()
Remove all elements from the queue.
📝 Source code
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 134
def clear
synchronize do
@queue.clear
end
end
🔎 See on GitHub
delete(element)
If element
is in the queue, remove and return it, or nil
.
📝 Source code
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 127
def delete(element)
synchronize do
@queue.delete(element)
end
end
🔎 See on GitHub
num_waiting()
Returns the number of threads currently waiting on this queue.
📝 Source code
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 112
def num_waiting
synchronize do
@num_waiting
end
end
🔎 See on GitHub
poll(timeout = nil)
Remove the head of the queue.
If timeout
is not given, remove and return the head of 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
iftimeout
is given and no element
becomes available within timeout
seconds,
📝 Source code
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 154
def poll(timeout = nil)
synchronize { internal_poll(timeout) }
end
🔎 See on GitHub