# frozen_string_literal: true # (The MIT License) # # Copyright (c) 2018 Yegor Bugayenko # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the 'Software'), to deal # in the Software without restriction, including without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in all # copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # SOFTWARE. require 'socket' require 'monitor' require_relative 'module' # Pool of TPC ports. # # Use it like this: # # RandomPort::Pool.new.acquire do |port| # # Use the TCP port. It will be returned back # # to the pool afterwards. # end # # You can specify the maximum amount of ports to acquire, using +limit+. # If more acquiring requests will arrive, an exception will be raised. # # The class is thread-safe, by default. You can configure it to be # not-thread-safe, using optional +sync+ argument of the constructor, # passing FALSE. # # Author:: Yegor Bugayenko (yegor256@gmail.com) # Copyright:: Copyright (c) 2018 Yegor Bugayenko # License:: MIT class RandomPort::Pool # If can't acquire by time out. class Timeout < StandardError; end attr_reader :limit # Ctor. # @param [bool] Set it to FALSE if you want this pool to be NOT thread-safe # @param [int] Set the maximum number of ports in the pool def initialize(sync: true, limit: 65_536) @ports = [] @sync = sync @monitor = Monitor.new @limit = limit end # Application wide pool of ports SINGLETON = RandomPort::Pool.new # How many ports acquired now? def count @ports.count end alias size count # Is it empty? def empty? @ports.empty? end # Acquire a new random TCP port. # # You can specify the number of ports to acquire. If it's more than one, # an array will be returned. # # You can specify the amount of seconds to wait until a new port # is available. def acquire(total = 1, timeout: 4) start = Time.now loop do if Time.now > start + timeout raise Timeout, "Can't find a place in the pool of #{@limit} ports \ for #{total} port(s), in #{format('%.02f', Time.now - start)}s" end opts = safe do next if @ports.count + total > @limit opts = Array.new(0, total) begin (0..(total - 1)).each do |i| opts[i] = i.zero? ? take : take(opts[i - 1] + 1) end rescue Errno::EADDRINUSE, SocketError next end next if opts.any? { |p| @ports.include?(p) } d = total * (total - 1) / 2 next unless opts.inject(&:+) - (total * opts.min) == d @ports += opts opts end next if opts.nil? opts = opts[0] if total == 1 return opts unless block_given? begin return yield opts ensure release(opts) end end end # Return it/them back to the pool. def release(port) safe do if port.is_a?(Array) port.each { |p| @ports.delete(p) } else @ports.delete(port) end end end private def take(opt = 0) server = TCPServer.new('127.0.0.1', opt) p = server.addr[1] server.close p end def safe(&block) if @sync @monitor.synchronize(&block) else yield end end end