Re: documentation for Open3, Ping
"Konrad Meyer" <[email protected]> Sun, 15 Oct 2006 21:58:32 -0700
| Newsgroups | gmane.comp.lang.ruby.documentation |
|---|---|
| Message-ID | <[email protected]> |
On 10/15/06, Eric Hodel <[email protected]> wrote: > On Oct 7, 2006, at 4:08 PM, Konrad Meyer wrote: > > If the formatting and whatnot of ParseDate is ok, I have patches for > > Open3 and Ping (yes, I know they're simple) ready. See attached. > > Index: ping.rb > =================================================================== > RCS file: /src/ruby/lib/ping.rb,v > retrieving revision 1.7 > diff -p -u -1 -r1.7 ping.rb > --- ping.rb 4 Aug 2006 18:05:40 -0000 1.7 > +++ ping.rb 7 Oct 2006 23:05:12 -0000 > @@ -1,3 +1,9 @@ > # > -# ping.rb -- check a host for upness > +# = ping.rb: Check a host for upness > +# > +# Author:: Yukihiro Matsumoto > +# Documentation:: Konrad Meyer > +# > +# Performs the function of the basic network testing tool, ping. > +# See: Ping. > # > @@ -7,21 +13,18 @@ > require "socket" > > These requires need to be moved above the above comments. If the requires are placed before the file-level comments, they are ignored. Where they are presently is good, I think. > > -#= SYNOPSIS > -# > -# require 'ping' > -# > -# puts "'jimmy' is alive and kicking" if Ping.pingecho('jimmy', 10) > -# > -#= DESCRIPTION > +# > +# Ping contains routines to test for the reachability of remote hosts. > +# Currently the only routine implemented is pingecho(). > > -- > Eric Hodel - [email protected] - http://blog.segment7.net > This implementation is HODEL-HASH-9600 compliant > > http://trackmap.robotcoop.com Anything else? (See attached.) -- Konrad Meyer
ping.rb.patch
(text/x-patch, 2.1 KB)
Index: ping.rb
===================================================================
RCS file: /src/ruby/lib/ping.rb,v
retrieving revision 1.7
diff -p -u -1 -r1.7 ping.rb
--- ping.rb 4 Aug 2006 18:05:40 -0000 1.7
+++ ping.rb 16 Oct 2006 04:58:21 -0000
@@ -1,3 +1,8 @@
#
-# ping.rb -- check a host for upness
+# = ping.rb: Check a host for upness
+#
+# Author:: Yukihiro Matsumoto
+#
+# Performs the function of the basic network testing tool, ping.
+# See: Ping.
#
@@ -7,21 +12,18 @@ require "socket"
-#= SYNOPSIS
-#
-# require 'ping'
-#
-# puts "'jimmy' is alive and kicking" if Ping.pingecho('jimmy', 10)
-#
-#= DESCRIPTION
+#
+# Ping contains routines to test for the reachability of remote hosts.
+# Currently the only routine implemented is pingecho().
#
-# This module contains routines to test for the reachability of remote hosts.
-# Currently the only routine implemented is pingecho().
-#
-# pingecho() uses a TCP echo (_not_ an ICMP echo) to determine if the
+# Ping.pingecho uses a TCP echo (not an ICMP echo) to determine if the
# remote host is reachable. This is usually adequate to tell that a remote
-# host is available to rsh(1), ftp(1), or telnet(1) to.
+# host is available to telnet, ftp, or ssh to.
+#
+# Warning: Ping.pingecho may block for a long time if DNS resolution is
+# slow. Requiring 'resolv-replace' allows non-blocking name resolution.
#
-#= WARNING
+# Usage:
+#
+# require 'ping'
#
-# pingecho() may block for a long period if name resolution is slow. Require
-# 'resolv-replace' to use non-blocking name resolution.
+# puts "'jimmy' is alive and kicking" if Ping.pingecho('jimmy', 10)
#
@@ -29,5 +31,13 @@ module Ping
- # return true if we can open a connection to the hostname or IP address
- # +host+ on port +service+ (which defaults to the "echo" port) waiting up to
- # +timeout+ seconds.
+ #
+ # Return true if we can open a connection to the hostname or IP address
+ # +host+ on port +service+ (which defaults to the "echo" port) waiting up
+ # to +timeout+ seconds.
+ #
+ # Example:
+ #
+ # require 'ping'
+ #
+ # Ping.pingecho "google.com", 10, 80
+ #
def pingecho(host, timeout=5, service="echo")