net-ping 1.4.1-x86-mingw32 → 1.5.3-x86-mingw32

data/lib/net/ping/ping.rb

@@ -1,88 +1,89 @@
-require 'socket'
-require 'timeout'
-
-# The Net module serves as a namespace only.
-#
-module Net
-
-   # The Ping class serves as an abstract base class for all other Ping class
-   # types. You should not instantiate this class directly.
-   #
-   class Ping
-      # The version of the net-ping library.
-      VERSION = '1.4.1'
-
-      # The host to ping. In the case of Ping::HTTP, this is the URI.
-      attr_accessor :host
-
-      # The port to ping. This is set to the echo port (7) by default. The
-      # Ping::HTTP class defaults to port 80.
-      #
-      attr_accessor :port
-
-      # The maximum time a ping attempt is made.
-      attr_accessor :timeout
-
-      # If a ping fails, this value is set to the error that occurred which
-      # caused it to fail.
-      #
-      attr_reader :exception
-
-      # 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.
-      #
-      attr_reader :warning
-
-      # 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.
-      #
-      attr_reader :duration
-
-      # 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.
-      #
-      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
-
-      # 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.
-      #--
-      # The @duration should be set in the subclass' ping method.
-      #
-      def ping(host = @host)
-         raise ArgumentError, 'no host specified' unless host
-         @exception = nil
-         @warning   = nil
-      end
-
-      alias ping? ping
-      alias pingecho ping
-   end
-end
+require 'socket'
+require 'timeout'
+
+# The Net module serves as a namespace only.
+#
+module Net
+
+   # The Ping class serves as an abstract base class for all other Ping class
+   # types. You should not instantiate this class directly.
+   #
+   class Ping
+      # The version of the net-ping library.
+      VERSION = '1.5.2'
+
+      # The host to ping. In the case of Ping::HTTP, this is the URI.
+      attr_accessor :host
+
+      # The port to ping. This is set to the echo port (7) by default. The
+      # Ping::HTTP class defaults to port 80.
+      #
+      attr_accessor :port
+
+      # The maximum time a ping attempt is made.
+      attr_accessor :timeout
+
+      # If a ping fails, this value is set to the error that occurred which
+      # caused it to fail.
+      #
+      attr_reader :exception
+
+      # 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.
+      #
+      attr_reader :warning
+
+      # 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.
+      #
+      attr_reader :duration
+
+      # 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.
+      #
+      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
+
+      # 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.
+      #--
+      # The @duration should be set in the subclass' ping method.
+      #
+      def ping(host = @host)
+         raise ArgumentError, 'no host specified' unless host
+         @exception = nil
+         @warning   = nil
+         @duration  = nil
+      end
+
+      alias ping? ping
+      alias pingecho ping
+   end
+end

data/lib/net/ping/tcp.rb

@@ -1,83 +1,83 @@
-require File.join(File.dirname(__FILE__), 'ping')
-
-# The Net module serves as a namespace only.
-module Net
-
-  # With a TCP ping simply try to open a connection. If we are successful,
-  # assume success. In either case close the connection to be polite.
-  #
-  class Ping::TCP < Ping
-    @@service_check = false
-
-    # Returns whether or not Errno::ECONNREFUSED is considered a successful
-    # ping. The default is false.
-    # 
-    def self.service_check
-      @@service_check
-    end
-
-    # Sets whether or not an Errno::ECONNREFUSED should be considered a
-    # successful ping.
-    # 
-    def self.service_check=(bool)
-      unless bool.kind_of?(TrueClass) || bool.kind_of?(FalseClass)
-        raise ArgumentError, 'argument must be true or false'
-      end
-      @@service_check = bool
-    end
-
-    # This method attempts to ping a host and port using a TCPSocket with
-    # the host, port and timeout values passed in the constructor.  Returns
-    # true if successful, or false otherwise.
-    # 
-    # Note that, by default, an Errno::ECONNREFUSED return result will be
-    # considered a failed ping.  See the documentation for the
-    # Ping::TCP.service_check= method if you wish to change this behavior.
-    # 
-    def ping(host=@host)
-      super(host)
-
-      bool = false
-      tcp = nil
-      start_time = Time.now
-
-      begin
-        Timeout.timeout(@timeout){
-          begin
-            tcp = TCPSocket.new(host, @port)
-          rescue Errno::ECONNREFUSED => err
-            if @@service_check
-              bool = true
-            else
-              @exception = err
-            end
-          rescue Exception => err
-            @exception = err
-          else
-            bool = true
-          end
-        }
-      rescue Timeout::Error => err
-        @exception = err
-      ensure
-        tcp.close if tcp
-      end
-
-      # There is no duration if the ping failed
-      @duration = Time.now - start_time if bool
-
-      bool
-    end
-
-    alias ping? ping
-    alias pingecho ping
-      
-    # Class method aliases. DEPRECATED.
-    class << self
-      alias econnrefused service_check
-      alias econnrefused= service_check=
-      alias ecr service_check
-      alias ecr= service_check=         
-    end
-  end
-end
+require File.join(File.dirname(__FILE__), 'ping')
+
+# The Net module serves as a namespace only.
+module Net
+
+  # With a TCP ping simply try to open a connection. If we are successful,
+  # assume success. In either case close the connection to be polite.
+  #
+  class Ping::TCP < Ping
+    @@service_check = false
+
+    # Returns whether or not Errno::ECONNREFUSED is considered a successful
+    # ping. The default is false.
+    # 
+    def self.service_check
+      @@service_check
+    end
+
+    # Sets whether or not an Errno::ECONNREFUSED should be considered a
+    # successful ping.
+    # 
+    def self.service_check=(bool)
+      unless bool.kind_of?(TrueClass) || bool.kind_of?(FalseClass)
+        raise ArgumentError, 'argument must be true or false'
+      end
+      @@service_check = bool
+    end
+
+    # This method attempts to ping a host and port using a TCPSocket with
+    # the host, port and timeout values passed in the constructor.  Returns
+    # true if successful, or false otherwise.
+    # 
+    # Note that, by default, an Errno::ECONNREFUSED return result will be
+    # considered a failed ping.  See the documentation for the
+    # Ping::TCP.service_check= method if you wish to change this behavior.
+    # 
+    def ping(host=@host)
+      super(host)
+
+      bool = false
+      tcp = nil
+      start_time = Time.now
+
+      begin
+        Timeout.timeout(@timeout){
+          begin
+            tcp = TCPSocket.new(host, @port)
+          rescue Errno::ECONNREFUSED => err
+            if @@service_check
+              bool = true
+            else
+              @exception = err
+            end
+          rescue Exception => err
+            @exception = err
+          else
+            bool = true
+          end
+        }
+      rescue Timeout::Error => err
+        @exception = err
+      ensure
+        tcp.close if tcp
+      end
+
+      # There is no duration if the ping failed
+      @duration = Time.now - start_time if bool
+
+      bool
+    end
+
+    alias ping? ping
+    alias pingecho ping
+      
+    # Class method aliases. DEPRECATED.
+    class << self
+      alias econnrefused service_check
+      alias econnrefused= service_check=
+      alias ecr service_check
+      alias ecr= service_check=         
+    end
+  end
+end

data/lib/net/ping/udp.rb

@@ -1,119 +1,119 @@
-require File.join(File.dirname(__FILE__), 'ping')
-
-# The Net module serves as a namespace only.
-module Net
-
-  # The Ping::UDP class encapsulates methods for UDP pings.
-  class Ping::UDP < Ping
-    @@service_check = true
-      
-    # Returns whether or not the connect behavior should enforce remote
-    # service availability as well as reachability. The default is true.
-    #
-    def self.service_check
-      @@service_check
-    end
-      
-    # Set whether or not the connect behavior should enforce remote
-    # service availability as well as reachability. If set to false
-    # then Errno::ECONNREFUSED or Errno::ECONNRESET will be considered
-    # a successful ping, meaning no actual data handshaking is required.
-    # By default, if either of those errors occurs it is considered a failed
-    # ping.
-    #
-    def self.service_check=(bool)
-      unless bool.kind_of?(TrueClass) || bool.kind_of?(FalseClass)
-        raise ArgumentError, 'argument must be true or false'
-      end
-      @@service_check = bool         
-    end
-      
-    # The maximum data size that can be sent in a UDP ping.
-    MAX_DATA = 64
-      
-    # The data to send to the remote host. By default this is 'ping'.
-    # This should be MAX_DATA size characters or less.
-    # 
-    attr_reader :data
-      
-    # Creates and returns a new Ping::UDP object.  This is effectively
-    # identical to its superclass constructor.
-    # 
-    def initialize(host=nil, port=nil, timeout=5)
-      @data = 'ping'
-
-      super(host, port, timeout)
-
-      @bind_host = nil
-      @bind_port = nil
-    end
-      
-    # Sets the data string sent to the remote host. This value cannot have
-    # a size greater than MAX_DATA.
-    # 
-    def data=(string)
-       if string.size > MAX_DATA
-         err = "cannot set data string larger than #{MAX_DATA} characters"
-         raise ArgumentError, err
-       end
-         
-       @data = string
-    end
-
-    # Associates the local end of the UDP connection with the given +host+
-    # and +port+. This is essentially a wrapper for UDPSocket#bind.
-    #
-    def bind(host, port)
-      @bind_host = host
-      @bind_port = port
-    end
-
-    # Sends a simple text string to the host and checks the return string. If
-    # the string sent and the string returned are a match then the ping was
-    # successful and true is returned. Otherwise, false is returned.
-    #
-    def ping(host = @host)
-      super(host)
-
-      bool  = false
-      udp   = UDPSocket.open
-      array = []
-
-      if @bind_host
-        udp.bind(@bind_host, @bind_port)
-      end
-
-      start_time = Time.now
-
-      begin
-        Timeout.timeout(@timeout){
-          udp.connect(host, @port)
-          udp.send(@data, 0)
-          array = udp.recvfrom(MAX_DATA)
-        }
-      rescue Errno::ECONNREFUSED, Errno::ECONNRESET => err
-        if @@service_check
-          @exception = err
-        else
-          bool = true
-        end
-      rescue Exception => err
-        @exception = err
-      else
-        if array[0] == @data
-          bool = true
-        end
-      ensure
-        udp.close if udp
-      end
-
-      # There is no duration if the ping failed
-      @duration = Time.now - start_time if bool
-
-      bool
-    end
-
-    alias ping? ping
-    alias pingecho ping
-  end
-end
+require File.join(File.dirname(__FILE__), 'ping')
+
+# The Net module serves as a namespace only.
+module Net
+
+  # The Ping::UDP class encapsulates methods for UDP pings.
+  class Ping::UDP < Ping
+    @@service_check = true
+      
+    # Returns whether or not the connect behavior should enforce remote
+    # service availability as well as reachability. The default is true.
+    #
+    def self.service_check
+      @@service_check
+    end
+      
+    # Set whether or not the connect behavior should enforce remote
+    # service availability as well as reachability. If set to false
+    # then Errno::ECONNREFUSED or Errno::ECONNRESET will be considered
+    # a successful ping, meaning no actual data handshaking is required.
+    # By default, if either of those errors occurs it is considered a failed
+    # ping.
+    #
+    def self.service_check=(bool)
+      unless bool.kind_of?(TrueClass) || bool.kind_of?(FalseClass)
+        raise ArgumentError, 'argument must be true or false'
+      end
+      @@service_check = bool         
+    end
+      
+    # The maximum data size that can be sent in a UDP ping.
+    MAX_DATA = 64
+      
+    # The data to send to the remote host. By default this is 'ping'.
+    # This should be MAX_DATA size characters or less.
+    # 
+    attr_reader :data
+      
+    # Creates and returns a new Ping::UDP object.  This is effectively
+    # identical to its superclass constructor.
+    # 
+    def initialize(host=nil, port=nil, timeout=5)
+      @data = 'ping'
+
+      super(host, port, timeout)
+
+      @bind_host = nil
+      @bind_port = nil
+    end
+      
+    # Sets the data string sent to the remote host. This value cannot have
+    # a size greater than MAX_DATA.
+    # 
+    def data=(string)
+       if string.size > MAX_DATA
+         err = "cannot set data string larger than #{MAX_DATA} characters"
+         raise ArgumentError, err
+       end
+         
+       @data = string
+    end
+
+    # Associates the local end of the UDP connection with the given +host+
+    # and +port+. This is essentially a wrapper for UDPSocket#bind.
+    #
+    def bind(host, port)
+      @bind_host = host
+      @bind_port = port
+    end
+
+    # Sends a simple text string to the host and checks the return string. If
+    # the string sent and the string returned are a match then the ping was
+    # successful and true is returned. Otherwise, false is returned.
+    #
+    def ping(host = @host)
+      super(host)
+
+      bool  = false
+      udp   = UDPSocket.open
+      array = []
+
+      if @bind_host
+        udp.bind(@bind_host, @bind_port)
+      end
+
+      start_time = Time.now
+
+      begin
+        Timeout.timeout(@timeout){
+          udp.connect(host, @port)
+          udp.send(@data, 0)
+          array = udp.recvfrom(MAX_DATA)
+        }
+      rescue Errno::ECONNREFUSED, Errno::ECONNRESET => err
+        if @@service_check
+          @exception = err
+        else
+          bool = true
+        end
+      rescue Exception => err
+        @exception = err
+      else
+        if array[0] == @data
+          bool = true
+        end
+      ensure
+        udp.close if udp
+      end
+
+      # There is no duration if the ping failed
+      @duration = Time.now - start_time if bool
+
+      bool
+    end
+
+    alias ping? ping
+    alias pingecho ping
+  end
+end