rb-wartslib 0.9.12 → 0.9.13

data/bin/trace-gap-size-hist

@@ -21,7 +21,7 @@
 ## along with this program; if not, write to the Free Software
 ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 ## 
-## $Id: trace-gap-size-hist,v 1.1 2007/11/30 01:14:48 youngh Exp $
+## $Id: trace-gap-size-hist,v 1.3 2008/02/02 00:01:24 youngh Exp $
 #############################################################################
 
 require 'rubygems'
@@ -72,7 +72,7 @@ def extract_ippath(trace)
     end
   end
 
-  retval << trace.dst if dest_response
+  retval << trace.dest if dest_response
   retval
 end
 
@@ -111,7 +111,7 @@ ARGV.each do |path|
     next
   end
 
-  file.add_filters Warts::File::TRACE
+  file.add_filters Warts::TRACE
   file.read do |trace|
     num_traces += 1
     if $options.verbose

data/bin/trace-timestamps-hist

@@ -20,7 +20,7 @@
 ## along with this program; if not, write to the Free Software
 ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 ## 
-## $Id: trace-timestamps-hist,v 1.1 2007/11/30 01:14:48 youngh Exp $
+## $Id: trace-timestamps-hist,v 1.2 2008/02/02 00:01:24 youngh Exp $
 ############################################################################
 
 require "rubygems"
@@ -31,7 +31,7 @@ histogram = Hash.new 0
 ARGV.each do |path|
   Warts::File.open(path) do |file|
     file.clear_all_filters
-    file.add_filters Warts::File::TRACE
+    file.add_filters Warts::TRACE
 
     previous_value = nil
     while (trace = file.read)

data/bin/w2tr

@@ -20,7 +20,7 @@
 ## along with this program; if not, write to the Free Software
 ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 ## 
-## $Id: w2tr,v 1.1 2007/11/30 00:02:53 youngh Exp $
+## $Id: w2tr,v 1.2 2008/02/02 00:01:24 youngh Exp $
 #############################################################################
 
 require 'rubygems'
@@ -30,7 +30,7 @@ out = Warts::File::open $stdout, "w", Warts::File::TRACEROUTE
 
 ARGV.each do |path|
   Warts::File::open(path) do |file|
-    file.add_filters Warts::File::TRACE
+    file.add_filters Warts::TRACE
     file.read do |trace|
       puts
       out.write trace

data/bin/wdump

@@ -25,7 +25,7 @@
 ## along with this program; if not, write to the Free Software
 ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 ## 
-## $Id: wdump,v 1.11 2007/12/08 00:43:48 youngh Exp $
+## $Id: wdump,v 1.18 2008/02/02 00:01:24 youngh Exp $
 #############################################################################
 
 require 'rubygems'
@@ -39,11 +39,12 @@ end
 def show_trace(trace)
   [
     :src,
-    :dst,
+    :dest,
     :hop_count,
     :stop_reason,
     :type,
     :flags,
+    :flags_breakdown,
     :attempts,
     :hoplimit ,
     :gaplimit,
@@ -68,6 +69,10 @@ def show_trace(trace)
     [
       :hop_addr,
       :hop_flags,
+      :hop_flags_breakdown,
+      :hop_has_reply_ttl?,
+      :hop_has_tcp_reply?,
+      :hop_has_icmp_reply?,
       :hop_probe_id,
       :hop_probe_ttl,
       :hop_reply_ttl,
@@ -76,8 +81,15 @@ def show_trace(trace)
       :hop_icmp_type,
       :hop_icmp_code,
       :hop_tcp_flags,
+      :hop_tcp_flags_breakdown,
       :hop_rtt_sec,
-      :hop_rtt_usec
+      :hop_rtt_usec,
+      :hop_reply_ipid,
+      :hop_reply_iptos,
+      :hop_next_hop_mtu,
+      :hop_inner_iplen,
+      :hop_inner_ipttl,
+      :hop_inner_iptos
     ].each do |name|
       print "  "
       show_attr trace, name, hop, response
@@ -88,7 +100,7 @@ end
 ARGV.each do |path|
   puts "\n:::: #{path} ::::"
   Warts::File::open(path) do |file|
-    file.add_filters Warts::File::TRACE
+    file.add_filters Warts::TRACE
     file.read do |trace|
       puts "=" * 70
       show_trace trace

data/docs/index.html

@@ -87,6 +87,14 @@ daily files, or into separate files by the type of probing method used).
 
 <h2><a name="installation"></a>Installation</h2>
 
+<p>
+You don't have to download anything manually to
+install <i>rb-wartslib</i>, because the gem file is already available
+on the online RubyGems repository.  Installation is, therefore, a
+simple matter of executing RubyGem's <code>gem</code> command on your
+system.
+</p>
+
 <p>
 If <i>rb-wartslib</i> were a typical Ruby Gem, you would install it with
 </p>
@@ -123,7 +131,7 @@ Now build and install <i>rb-wartslib:</i>
 
 <pre>
   $ SCAMPER=/Users/youngh/scamper-cvs-20070523h
-     (set the above to the directory where you built scamper)
+     (set the above to the <b>absolute</b> directory where you built scamper)
   $ sudo gem install rb-wartslib -- --with-scamper-include=$SCAMPER
        --with-scamper-lib=$SCAMPER
 </pre>

data/docs/reference.html

@@ -27,6 +27,7 @@
 <li> <a href="index.html#installation">Installation</a></li>
 <li> <a href="tutorial.html">Tutorial</a></li>
 <li> <a href="reference.html"><b>Class Reference</b></a></li>
+<li> <a href="#Warts_module">&nbsp;&nbsp;&bull; Warts Module</a></li>
 <li> <a href="#File_class">&nbsp;&nbsp;&bull; Warts::File</a></li>
 <li> <a href="#Trace_class">&nbsp;&nbsp;&bull; Warts::Trace</a></li>
 <li> <a href="#List_class">&nbsp;&nbsp;&bull; Warts::List</a></li>
@@ -48,12 +49,33 @@
 <b>Under construction...</b>
 </p>
 
-<h2><a name="File_class"></a>Warts::File</h2>
+<!--- =================================================================== --->
+<!--- =================================================================== --->
+
+<h2><a name="Warts_module"></a>Warts Module</h2>
+
+<h3><a name="Warts_version_constants"></a>Version Constants</h3>
+
+<dl>
+  <dt>WARTS_LIB_VERSION</dt>
+  <dd>Provides the version string of rb-wartslib (e.g.,
+      <code>"0.9.13"</code>).</dd>
+
+  <dt>SCAMPER_VERSION</dt>
+  <dd>Provides the version string of the scamper codebase used to build
+      rb-wartslib (e.g., <code>"20070523j"</code>).</dd>
+</dd>
+</dl>
 
-<h3><a name="File_object_types"></a>Object Type Constants</h3>
+<h3><a name="Warts_type_constants"></a>Object Type Constants</h3>
 
-<p class="constant_desc">
-These constants are used to specify a filter in a call to
+<p>
+These constants are used in various places to identify a particular type of
+Warts data object.  For example, they are returned by
+the <code>element_type</code> method available on all data classes in the
+Warts module (e.g., <code>Warts::Trace#element_type</code>,
+<code>Warts::List#element_type</code>).
+These constants are also used to specify filters in a call to
 <a href="#File_add_filters_method"><code>Warts::File#add_filters</code></a>
 and related methods.
 </p>
@@ -101,9 +123,14 @@ single IPv4/IPv6 ping to a single destination.</dd>
 </dl>
 
 
-<h3><a name="File_object_types"></a>File Type Constants</h3>
+<!--- =================================================================== --->
+<!--- =================================================================== --->
 
-<p class="constant_desc">
+<h2><a name="File_class"></a>Warts::File</h2>
+
+<h3><a name="File_file_types"></a>File Type Constants</h3>
+
+<p>
 These constants are used to specify the file format in a call to
 <a href="#File_open_method"><code>Warts::File.open</code></a>.
 </p>
@@ -196,7 +223,7 @@ The <code>Warts::File#read</code> method returns the next element stored in
 a warts/arts++ file.  You specify the types of elements you are interested
 in (that is, to read in) with <code>Warts::File#add_filters</code>.
 The <code>count-traces</code> script above only specifies
-the <code>Warts::File::TRACE</code> filter, so only IPv4 and IPv6
+the <code>Warts::TRACE</code> filter, so only IPv4 and IPv6
 traceroute elements are returned by <code>read</code>.  These traceroute
 elements are instances of <code>Warts::Trace</code>, which provides
 numerous accessor methods for getting at both the data and the metadata of
@@ -217,10 +244,306 @@ convenience methods.
 Closes an open file.
 </p>
 
+
+<!--- =================================================================== --->
+<!--- =================================================================== --->
+
 <h2><a name="Trace_class"></a>Warts::Trace</h2>
 
+<h3>Instance Attributes</h3>
+
+<h4 class="method_sig"><a name="Trace_type_attribute"></a><span class="method_name">type</span></h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_flags_attribute"></a><span class="method_name">flags</span></h4>
+
+<h4 class="method_sig"><a name="Trace_list_attribute"></a><span class="method_name">list</span></h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_cycle_attribute"></a><span class="method_name">cycle</span></h4>
+
+<p class="method_desc">
+</p>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_src_attribute"></a><span class="method_name">src</span></h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_dest_attribute"></a><span class="method_name">dest</span></h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_dest_rtt_attribute"></a><span class="method_name">dest_rtt</span></h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_dest_rtt_str_attribute"></a><span class="method_name">dest_rtt_str</span></h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_start_attribute"></a><span class="method_name">start</span></h4>
+
+<p class="method_desc">
+The timestamp (in whole seconds) of the start of the trace.
+</p>
+
+<h4 class="method_sig"><a name="Trace_start_usec_attribute"></a><span class="method_name">start_usec</span></h4>
+
+<p class="method_desc">
+The fractional component of the trace's start timestamp given as a whole
+number of microseconds.  This value is an integer, so half a second would
+be specified with 500000.  Suitably combine this value with the start
+timestamp to get a microsecond-precision starting timestamp; that is,
+<code>t = start + start_usec / 1e6</code> would give a precise starting
+timestamp.
+</p>
+
+<h4 class="method_sig"><a name="Trace_hop_count_attribute"></a><span class="method_name">hop_count</span></h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_stop_reason_attribute"></a><span class="method_name">stop_reason</span></h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_stop_data_attribute"></a><span class="method_name">stop_data</span></h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_attempts_attribute"></a><span class="method_name">attempts</span></h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_hoplimit_attribute"></a><span class="method_name">hoplimit</span></h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_gaplimit_attribute"></a><span class="method_name">gaplimit</span></h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_firsthop_attribute"></a><span class="method_name">firsthop</span></h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_tos_attribute"></a><span class="method_name">tos</span></h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_wait_attribute"></a><span class="method_name">wait</span></h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_loops_attribute"></a><span class="method_name">loops</span></h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_probe_size_attribute"></a><span class="method_name">probe_size</span></h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_sport_attribute"></a><span class="method_name">sport</span></h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_dport_attribute"></a><span class="method_name">dport</span></h4>
+
+<p class="method_desc">
+</p>
+
+
+<h3>Instance Methods</h3>
+
+<h4 class="method_sig"><a name="Trace_src_cmp_method"></a><span class="method_name">src_cmp</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_dest_cmp_method"></a><span class="method_name">dest_cmp</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_cycle=_method"></a><span class="method_name">cycle=</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_hop_exists?_method"></a><span class="method_name">hop_exists?</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_hop_dest_response?_method"></a><span class="method_name">hop_dest_response?</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_find_dest_response_method"></a><span class="method_name">find_dest_response</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_complete?_method"></a><span class="method_name">complete?</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_each_hop_method"></a><span class="method_name">each_hop</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_each_response_method"></a><span class="method_name">each_response</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_each_hop_and_response_method"></a><span class="method_name">each_hop_and_response</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_dest_responded?_method"></a><span class="method_name">dest_responded?</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_each_method"></a><span class="method_name">each</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<!--- ================================================================== --->
+
+<h4 class="method_sig"><a name="Trace_hop_addr_method"></a><span class="method_name">hop_addr</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_hop_flags_method"></a><span class="method_name">hop_flags</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_hop_probe_id_method"></a><span class="method_name">hop_probe_id</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_hop_probe_ttl_method"></a><span class="method_name">hop_probe_ttl</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_hop_reply_ttl_method"></a><span class="method_name">hop_reply_ttl</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_hop_probe_size_method"></a><span class="method_name">hop_probe_size</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_hop_reply_size_method"></a><span class="method_name">hop_reply_size</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_hop_icmp_type_method"></a><span class="method_name">hop_icmp_type</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_hop_icmp_code_method"></a><span class="method_name">hop_icmp_code</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_hop_tcp_flags_method"></a><span class="method_name">hop_tcp_flags</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_hop_rtt_method"></a><span class="method_name">hop_rtt</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_hop_rtt_str_method"></a><span class="method_name">hop_rtt_str</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_hop_rtt_sec_method"></a><span class="method_name">hop_rtt_sec</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_hop_rtt_usec_method"></a><span class="method_name">hop_rtt_usec</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_hop_reply_ipid_method"></a><span class="method_name">hop_reply_ipid</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_hop_reply_iptos_method"></a><span class="method_name">hop_reply_iptos</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_hop_next_hop_mtu_method"></a><span class="method_name">hop_next_hop_mtu</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_hop_inner_iplen_method"></a><span class="method_name">hop_inner_iplen</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+<h4 class="method_sig"><a name="Trace_hop_inner_ipttl_method"></a><span class="method_name">hop_inner_ipttl</span>(<span class="method_argument">hop_index</span>, <span class="method_argument">response_index</span><code class="method_default">=0</code>)</h4>
+
+<p class="method_desc">
+</p>
+
+
+<!--- =================================================================== --->
+<!--- =================================================================== --->
+
 <h2><a name="List_class"></a>Warts::List</h2>
 
+
+<!--- =================================================================== --->
+<!--- =================================================================== --->
+
 <h2><a name="Cycle_class"></a>Warts::Cycle</h2>