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.

Instance Method Summary collapse

Constructor Details

#initialize(lock = Monitor.new) ⇒ Queue

Returns a new instance of Queue


75
76
77
78
79
80
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb', line 75

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.


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

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)

83
84
85
86
87
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb', line 83

def any_waiting?
  synchronize do
    @num_waiting > 0
  end
end

#clearObject

Remove all elements from the queue.


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

def clear
  synchronize do
    @queue.clear
  end
end

#delete(element) ⇒ Object

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


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

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

#num_waitingObject

Return the number of threads currently waiting on this queue.


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

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,


133
134
135
136
137
138
139
140
141
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb', line 133

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