class Net::Ping

The Ping class serves as an abstract base class for all other Ping class types. You should not instantiate this class directly.

Constants

VERSION

The version of the net-ping library.

Attributes

duration[R]

The number of seconds (returned as a Float) that it took to ping the host. This is not a precise value, but rather a good estimate since there is a small amount of internal calculation that is added to the overall time.

exception[R]

If a ping fails, this value is set to the error that occurred which caused it to fail.

host[RW]

The host to ping. In the case of Ping::HTTP, this is the URI.

port[RW]

The port to ping. This is set to the echo port (7) by default. The Ping::HTTP class defaults to port 80.

timeout[RW]

The maximum time a ping attempt is made.

warning[R]

This value is set if a ping succeeds, but some other condition arose during the ping attempt which merits warning, e.g a redirect in the case of Ping::HTTP#ping.

Public Class Methods

new(host=nil, port=nil, timeout=5) { |self| ... } click to toggle source

The default constructor for the Net::Ping class. Accepts an optional host, port and timeout. The port defaults to your echo port, or 7 if that happens to be undefined. The default timeout is 5 seconds.

The host, although optional in the constructor, must be specified at some point before the Net::Ping#ping method is called, or else an ArgumentError will be raised.

Yields self in block context.

This class is not meant to be instantiated directly. It is strictly meant as an interface for subclasses.

# File lib/net/ping/ping.rb, line 57
def initialize(host=nil, port=nil, timeout=5)
   @host      = host
   @port      = port || Socket.getservbyname('echo') || 7
   @timeout   = timeout
   @exception = nil
   @warning   = nil
   @duration  = nil

   yield self if block_given?
end

Public Instance Methods

ping(host = @host) click to toggle source

The default interface for the Net::Ping#ping method. Each subclass should call super() before continuing with their own implementation in order to ensure that the @exception and @warning instance variables are reset.

If host is nil here, then it will use the host specified in the constructor. If the host is nil and there was no host specified in the constructor then an ArgumentError is raised.

# File lib/net/ping/ping.rb, line 79
def ping(host = @host)
   raise ArgumentError, 'no host specified' unless host
   @exception = nil
   @warning   = nil
   @duration  = nil
end
Also aliased as: pingecho
ping6(host = @host) click to toggle source
# File lib/net/ping/ping.rb, line 86
def ping6(host = @host)
   raise ArgumentError, 'no host specified' unless host
   @exception = nil
   @warning   = nil
   @duration  = nil
end
ping?(host = @host) click to toggle source
# File lib/net/ping/ping.rb, line 93
def ping?(host = @host)
  !!ping(host)
end
pingecho(host = @host)
Alias for: ping