Parent

Net::Ping::HTTP

The Ping::HTTP class encapsulates methods for HTTP pings.

Attributes

follow_redirect[RW]

By default an http ping will follow a redirect and give you the result of the final URI. If this value is set to false, then it will not follow a redirect and will return false immediately on a redirect.

follow_redirect?[RW]

By default an http ping will follow a redirect and give you the result of the final URI. If this value is set to false, then it will not follow a redirect and will return false immediately on a redirect.

get_request[RW]

Use GET request instead HEAD. The default is false.

redirect_limit[RW]

The maximum number of redirects allowed. The default is 5.

ssl_verify_mode[RW]

OpenSSL certificate verification mode. The default is VERIFY_NONE.

user_agent[RW]

The user agent used for the HTTP request. The default is nil.

Public Class Methods

new(uri=nil, port=nil, timeout=5) click to toggle source

Creates and returns a new Ping::HTTP object. The default port is the port associated with the URI. The default timeout is 5 seconds.

# File lib/net/ping/http.rb, line 39
def initialize(uri=nil, port=nil, timeout=5)
  @follow_redirect = true
  @redirect_limit  = 5
  @ssl_verify_mode = OpenSSL::SSL::VERIFY_NONE
  @get_request = false

  port ||= URI.parse(uri).port if uri

  super(uri, port, timeout)
end

Public Instance Methods

ping(host = @host) click to toggle source

Looks for an HTTP response from the URI passed to the constructor. If the result is a kind of Net::HTTPSuccess then the ping was successful and true is returned. Otherwise, false is returned and the Ping::HTTP#exception method should contain a string indicating what went wrong.

If the HTTP#follow_redirect accessor is set to true (which it is by default) and a redirect occurs during the ping, then the HTTP#warning attribute is set to the redirect message, but the return result is still true. If it's set to false then a redirect response is considered a failed ping.

If no file or path is specified in the URI, then '/' is assumed.

# File lib/net/ping/http.rb, line 64
def ping(host = @host)
  super(host)
  bool = false
  uri = URI.parse(host)

  start_time = Time.now

  response = do_ping(uri)

  if response.is_a?(Net::HTTPSuccess)
    bool = true
  elsif redirect?(response) # Check code, HTTPRedirection does not always work
    if @follow_redirect
      @warning = response.message
      rlimit = 0

      while redirect?(response)
        if rlimit >= redirect_limit
          @exception = "Redirect limit exceeded"
          break
        end
        redirect = URI.parse(response['location'])
        redirect = uri + redirect if redirect.relative?
        response = do_ping(redirect)
        rlimit += 1
      end

      if response.is_a?(Net::HTTPSuccess)
        bool = true
      else
        @warning = nil
        @exception ||= response.message
      end

    else
      @exception = response.message
    end
  end

  # There is no duration if the ping failed
  @duration = Time.now - start_time if bool

  bool
end
Also aliased as: ping?, pingecho
ping?(host = @host) click to toggle source
Alias for: ping
pingecho(host = @host) click to toggle source
Alias for: ping

[Validate]

Generated with the Darkfish Rdoc Generator 2.