Class: ConnectionPool

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

Overview

Generic connection pool class for e.g. sharing a limited number of network connections among many threads. Note: Connections are eager 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

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: TimedStack, Wrapper

Constant Summary collapse

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of ConnectionPool.

Raises:

  • (ArgumentError)

33
34
35
36
37
38
39
40
41
42
43
# File 'lib/connection_pool.rb', line 33

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

  options = DEFAULTS.merge(options)

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

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

Class Method Details

.wrap(options, &block) ⇒ Object


29
30
31
# File 'lib/connection_pool.rb', line 29

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

Instance Method Details

#checkinObject


67
68
69
70
71
72
73
74
# File 'lib/connection_pool.rb', line 67

def checkin
  stack = ::Thread.current[@key]
  conn = stack.pop
  if stack.empty?
    @available << conn
  end
  nil
end

#checkoutObject


54
55
56
57
58
59
60
61
62
63
64
65
# File 'lib/connection_pool.rb', line 54

def checkout
  stack = ::Thread.current[@key] ||= []

  if stack.empty?
    conn = @available.pop(@timeout)
  else
    conn = stack.last
  end

  stack.push conn
  conn
end

#withObject


45
46
47
48
49
50
51
52
# File 'lib/connection_pool.rb', line 45

def with
  conn = checkout
  begin
    yield conn
  ensure
    checkin
  end
end