Parent

Object

ConnectionPool

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:

Public Class Methods

new(options = {}, &block) click to toggle source 
# File lib/connection_pool.rb, line 34
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
wrap(options, &block) click to toggle source 
# File lib/connection_pool.rb, line 30
def self.wrap(options, &block)
  Wrapper.new(options, &block)
end

Public Instance Methods

checkin() click to toggle source 
# File lib/connection_pool.rb, line 68
def checkin
  stack = ::Thread.current[@key]
  conn = stack.pop
  if stack.empty?
    @available << conn
  end
  nil
end
checkout() click to toggle source 
# File lib/connection_pool.rb, line 55
def checkout
  stack = ::Thread.current[@key] ||= []

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

  stack.push conn
  conn
end
shutdown(&block) click to toggle source 
# File lib/connection_pool.rb, line 77
def shutdown(&block)
  @available.shutdown(&block)
end
with() click to toggle source 
# File lib/connection_pool.rb, line 46
def with
  conn = checkout
  begin
    yield conn
  ensure
    checkin
  end
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.