connection_pool/lib/connection_pool.rb

require 'connection_pool/version'
require 'timed_queue'

# 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 a global connection (slower):
#
#    REDIS = ConnectionPool.new { 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
#
class ConnectionPool < BasicObject
  DEFAULTS = { :size => 5, :timeout => 5 }

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

    @available = ::TimedQueue.new
    @oid = @available.object_id
    @options = DEFAULTS.merge(options)
    @options[:size].times do
      @available << block.call
    end
  end

  def with(&block)
    yield checkout
  ensure
    checkin
  end
  alias_method :with_connection, :with

  def method_missing(name, *args, &block)
    checkout.send(name, *args, &block)
  ensure
    checkin
  end

  private

  def checkout
    ::Thread.current[:"current-#{@oid}"] ||= begin
      @available.timed_pop(@options[:timeout])
    end
  end

  def checkin
    conn = ::Thread.current[:"current-#{@oid}"]
    ::Thread.current[:"current-#{@oid}"] = nil
    return unless conn
    @available << conn
    nil
  end

end