A Ruby gem to reserve a random TCP port
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib #4 sync Nov 12, 2018
test #4 extra test Nov 12, 2018
.0pdd.yml #1 skeleton Oct 4, 2018
.gitignore
.pdd #1 skeleton Oct 4, 2018
.rubocop.yml
.rultor.yml
.travis.yml #1 travis 2.3.3 Oct 4, 2018
Gemfile #1 skeleton Oct 4, 2018
README.md #4 sync Nov 12, 2018
Rakefile
random-port.gemspec #4 sync Nov 12, 2018

README.md

DevOps By Rultor.com We recommend RubyMine

Build Status Gem Version Maintainability Yard Docs

It's a simple Ruby gem to get a random TCP port.

First, install it:

$ gem install random-port

Then, use it like this, to reserve a random TCP port:

require 'random-port'
port = RandomPort::Pool.new.acquire

The Pool guarantees that the port won't be used again. You can put the port back to the pool after usage:

RandomPort::Pool.new.acquire do |port|
  # Use the TCP port. It will be returned back
  # to the pool afterwards.
end

You can do it without the block:

pool = RandomPort::Pool.new
port = pool.acquire
pool.release(port)

You can also use a pre-defined Pool::SINGLETON singleton:

RandomPort::Pool::SINGLETON.acquire do |port|
  # Use it here...
end

The pool is thread-safe by default. You can configure it to be not-thread-safe, using optional sync argument of the constructor.

How to contribute

Read these guidelines. Make sure you build is green before you contribute your pull request. You will need to have Ruby 2.3+ and Bundler installed. Then:

$ bundle update
$ rake

If it's clean and you don't see any error messages, submit your pull request.

License

(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.