Sha256: 0bdeb14a7cca8e67a3a5f9483cdf306e0cb4821d51954b016affce4b9153cc55

Contents?: true

Size: 1.44 KB

Versions: 26

Compression:

Stored size: 1.44 KB

Contents

require "socket"
require "timeout"

module Vagrant
  module Util
    # Contains the method {#is_port_open?} to check if a port is open
    # (listening) or closed (not in use). This method isn't completely
    # fool-proof, but it works enough of the time to be useful.
    module IsPortOpen
      # Checks if a port is open (listening) on a given host and port.
      #
      # @param [String] host Hostname or IP address.
      # @param [Integer] port Port to check.
      # @return [Boolean] `true` if the port is open (listening), `false`
      #   otherwise.
      def is_port_open?(host, port)
        # We wrap this in a timeout because once in awhile the TCPSocket
        # _will_ hang, but this signals that the port is closed.
        Timeout.timeout(1) do
          # Attempt to make a connection
          s = TCPSocket.new(host, port)

          # A connection was made! Properly clean up the socket, not caring
          # at all if any exception is raised, because we already know the
          # result.
          s.close rescue nil

          # The port is open if we reached this point, since we were able
          # to connect.
          return true
        end
      rescue Timeout::Error, Errno::ECONNREFUSED, Errno::EHOSTUNREACH, \
             Errno::ENETUNREACH, Errno::EACCES, Errno::ENOTCONN, \
             Errno::EADDRNOTAVAIL
        # Any of the above exceptions signal that the port is closed.
        return false
      end
    end
  end
end

Version data entries

26 entries across 22 versions & 4 rubygems

Version Path
vagrant-unbundled-2.2.6.2 lib/vagrant/util/is_port_open.rb
vagrant-unbundled-2.2.6.1 lib/vagrant/util/is_port_open.rb
vagrant-unbundled-2.2.6.0 lib/vagrant/util/is_port_open.rb
vagrant-unbundled-2.2.5.0 lib/vagrant/util/is_port_open.rb
vagrant-unbundled-2.2.4.0 lib/vagrant/util/is_port_open.rb
vagrant-unbundled-2.2.3.0 lib/vagrant/util/is_port_open.rb
vagrant-unbundled-2.2.2.0 lib/vagrant/util/is_port_open.rb
vagrant-unbundled-2.2.0.0 lib/vagrant/util/is_port_open.rb
vagrant-unbundled-2.1.4.0 lib/vagrant/util/is_port_open.rb
vagrant-unbundled-2.1.2.0 lib/vagrant/util/is_port_open.rb
vagrant-packet-0.1.2 vendor/bundle/ruby/2.5.0/bundler/gems/vagrant-04f7215b5e3f/lib/vagrant/util/is_port_open.rb
vagrant-packet-0.1.2 vendor/bundle/ruby/2.3.0/bundler/gems/vagrant-04f7215b5e3f/lib/vagrant/util/is_port_open.rb
vagrant-packet-0.1.2 vendor/bundle/ruby/2.4.0/bundler/gems/vagrant-04f7215b5e3f/lib/vagrant/util/is_port_open.rb
vagrant-packet-0.1.1 vendor/bundle/ruby/2.3.0/bundler/gems/vagrant-04f7215b5e3f/lib/vagrant/util/is_port_open.rb
vagrant-packet-0.1.1 vendor/bundle/ruby/2.5.0/bundler/gems/vagrant-04f7215b5e3f/lib/vagrant/util/is_port_open.rb
vagrant-packet-0.1.1 vendor/bundle/ruby/2.4.0/bundler/gems/vagrant-04f7215b5e3f/lib/vagrant/util/is_port_open.rb
vagrant-unbundled-2.1.1.0 lib/vagrant/util/is_port_open.rb
vagrant-unbundled-2.0.4.0 lib/vagrant/util/is_port_open.rb
vagrant-unbundled-2.0.3.0 lib/vagrant/util/is_port_open.rb
vagrant-aws-detiber-0.7.2.pre.4 vendor/bundle/ruby/2.3.0/bundler/gems/vagrant-419afb4dcffe/lib/vagrant/util/is_port_open.rb