Class: Bundler::ConnectionPool::TimedStack

Inherits:
Object
  • Object
show all
Defined in:
lib/bundler/vendor/connection_pool/lib/connection_pool/timed_stack.rb

Overview

Examples:

ts = TimedStack.new(1) { MyConnection.new }

# fetch a connection
conn = ts.pop

# return a connection
ts.push conn

conn = ts.pop
ts.pop timeout: 5
#=> raises Timeout::Error after 5 seconds

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(size = 0, &block) ⇒ TimedStack

Creates a new pool with size connections that are created from the given block.


37
38
39
40
41
42
43
44
45
# File 'lib/bundler/vendor/connection_pool/lib/connection_pool/timed_stack.rb', line 37

def initialize(size = 0, &block)
  @create_block = block
  @created = 0
  @que = []
  @max = size
  @mutex = Mutex.new
  @resource = ConditionVariable.new
  @shutdown_block = nil
end

Instance Attribute Details

#maxObject (readonly)

Returns the value of attribute max


31
32
33
# File 'lib/bundler/vendor/connection_pool/lib/connection_pool/timed_stack.rb', line 31

def max
  @max
end

Instance Method Details

#empty?Boolean

Returns true if there are no available connections.

Returns:

  • (Boolean)

111
112
113
# File 'lib/bundler/vendor/connection_pool/lib/connection_pool/timed_stack.rb', line 111

def empty?
  (@created - @que.length) >= @max
end

#lengthObject

The number of connections available on the stack.


118
119
120
# File 'lib/bundler/vendor/connection_pool/lib/connection_pool/timed_stack.rb', line 118

def length
  @max - @created + @que.length
end

#pop(timeout = 0.5, options = {}) ⇒ Object

Retrieves a connection from the stack. If a connection is available it is immediately returned. If no connection is available within the given timeout a Timeout::Error is raised.

:timeout is the only checked entry in options and is preferred over the timeout argument (which will be removed in a future release). Other options may be used by subclasses that extend TimedStack.


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'lib/bundler/vendor/connection_pool/lib/connection_pool/timed_stack.rb', line 73

def pop(timeout = 0.5, options = {})
  options, timeout = timeout, 0.5 if Hash === timeout
  timeout = options.fetch :timeout, timeout

  deadline = Bundler::ConnectionPool.monotonic_time + timeout
  @mutex.synchronize do
    loop do
      raise Bundler::ConnectionPool::PoolShuttingDownError if @shutdown_block
      return fetch_connection(options) if connection_stored?(options)

      connection = try_create(options)
      return connection if connection

      to_wait = deadline - Bundler::ConnectionPool.monotonic_time
      raise Timeout::Error, "Waited #{timeout} sec" if to_wait <= 0
      @resource.wait(@mutex, to_wait)
    end
  end
end

#push(obj, options = {}) ⇒ Object Also known as: <<

Returns obj to the stack. options is ignored in TimedStack but may be used by subclasses that extend TimedStack.


51
52
53
54
55
56
57
58
59
60
61
# File 'lib/bundler/vendor/connection_pool/lib/connection_pool/timed_stack.rb', line 51

def push(obj, options = {})
  @mutex.synchronize do
    if @shutdown_block
      @shutdown_block.call(obj)
    else
      store_connection obj, options
    end

    @resource.broadcast
  end
end

#shutdown(&block) ⇒ Object

Shuts down the TimedStack which prevents connections from being checked out. The block is called once for each connection on the stack.

Raises:

  • (ArgumentError)

97
98
99
100
101
102
103
104
105
106
# File 'lib/bundler/vendor/connection_pool/lib/connection_pool/timed_stack.rb', line 97

def shutdown(&block)
  raise ArgumentError, "shutdown must receive a block" unless block_given?

  @mutex.synchronize do
    @shutdown_block = block
    @resource.broadcast

    shutdown_connections
  end
end