Class: ConnectionPool

Inherits:
Object
  • Object
show all
Defined in:
lib/connection_pool.rb,
lib/connection_pool.rb,
lib/connection_pool/version.rb,
lib/connection_pool/wrapper.rb

Overview

Generic connection pool class for sharing a limited number of objects or network connections among many threads. Note: pool elements are lazily created.

Example usage with block (faster):

@pool = ConnectionPool.new { Redis.new }
@pool.with do |redis|
  redis.lpop('my-list') if redis.llen('my-list') > 0
end

Using optional timeout override (for that single invocation)

@pool.with(timeout: 2.0) do |redis|
  redis.lpop('my-list') if redis.llen('my-list') > 0
end

Example usage replacing an existing connection (slower):

$redis = ConnectionPool.wrap { Redis.new }

def do_work
  $redis.lpop('my-list') if $redis.llen('my-list') > 0
end

Accepts the following options:

  • :size - number of connections to pool, defaults to 5

  • :timeout - amount of time to wait for a connection if none currently available, defaults to 5 seconds

Defined Under Namespace

Classes: Error, PoolShuttingDownError, TimedStack, TimeoutError, Wrapper

Constant Summary collapse

DEFAULTS = 
{size: 5, timeout: 5}
VERSION = 
"2.3.0"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}, &block) ⇒ ConnectionPool

Returns a new instance of ConnectionPool.

Raises:

  • (ArgumentError) 


47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/connection_pool.rb', line 47

def initialize(options = {}, &block)
  raise ArgumentError, "Connection pool requires a block" unless block

  options = DEFAULTS.merge(options)

  @size = Integer(options.fetch(:size))
  @timeout = options.fetch(:timeout)

  @available = TimedStack.new(@size, &block)
  @key = :"pool-#{@available.object_id}"
  @key_count = :"pool-#{@available.object_id}-count"
end

Instance Attribute Details

#size ⇒ Object (readonly)

Size of this connection pool



119
120
121
 
# File 'lib/connection_pool.rb', line 119

def size
  @size
end

Class Method Details

.wrap(options, &block) ⇒ Object 



43
44
45
 
# File 'lib/connection_pool.rb', line 43

def self.wrap(options, &block)
  Wrapper.new(options, &block)
end

Instance Method Details

#available ⇒ Object

Number of pool entries available for checkout at this instant.



122
123
124
 
# File 'lib/connection_pool.rb', line 122

def available
  @available.length
end

#checkin ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/connection_pool.rb', line 84

def checkin
  if ::Thread.current[@key]
    if ::Thread.current[@key_count] == 1
      @available.push(::Thread.current[@key])
      ::Thread.current[@key] = nil
      ::Thread.current[@key_count] = nil
    else
      ::Thread.current[@key_count] -= 1
    end
  else
    raise ConnectionPool::Error, "no connections are checked out"
  end

  nil
end

#checkout(options = {}) ⇒ Object 



74
75
76
77
78
79
80
81
82
 
# File 'lib/connection_pool.rb', line 74

def checkout(options = {})
  if ::Thread.current[@key]
    ::Thread.current[@key_count] += 1
    ::Thread.current[@key]
  else
    ::Thread.current[@key_count] = 1
    ::Thread.current[@key] = @available.pop(options[:timeout] || @timeout)
  end
end

#reload(&block) ⇒ Object

Reloads the ConnectionPool by passing each connection to block and then removing it the pool. Subsequent checkouts will create new connections as needed.



114
115
116
 
# File 'lib/connection_pool.rb', line 114

def reload(&block)
  @available.shutdown(reload: true, &block)
end

#shutdown(&block) ⇒ Object

Shuts down the ConnectionPool by passing each connection to block and then removing it from the pool. Attempting to checkout a connection after shutdown will raise ConnectionPool::PoolShuttingDownError.



105
106
107
 
# File 'lib/connection_pool.rb', line 105

def shutdown(&block)
  @available.shutdown(&block)
end

#with(options = {}) ⇒ Object Also known as: then 



60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/connection_pool.rb', line 60

def with(options = {})
  Thread.handle_interrupt(Exception => :never) do
    conn = checkout(options)
    begin
      Thread.handle_interrupt(Exception => :immediate) do
        yield conn
      end
    ensure
      checkin
    end
  end
end