A few documentation nits
authorTom Henderson <tomh@tomh.org>
Fri, 12 Dec 2008 17:18:29 -0800
changeset 4020 4fa0b1ed5240
parent 4019 7c053d22ffc0
child 4021 f8a5d0a63f4e
A few documentation nits
doc/manual/attributes.texi
doc/manual/routing.texi
doc/manual/sockets.texi
examples/dynamic-global-routing.cc
--- a/doc/manual/attributes.texi	Fri Dec 12 14:52:16 2008 -0800
+++ b/doc/manual/attributes.texi	Fri Dec 12 17:18:29 2008 -0800
@@ -713,7 +713,7 @@
 
 @subsection Future work
 There are a couple of possible improvements:
-@itemize bullet
+@itemize @bullet
 @item save a unique version number with date and time at start of file
 @item save rng initial seed somewhere.
 @item make each RandomVariable serialize its own initial seed and re-read
--- a/doc/manual/routing.texi	Fri Dec 12 14:52:16 2008 -0800
+++ b/doc/manual/routing.texi	Fri Dec 12 17:18:29 2008 -0800
@@ -301,6 +301,20 @@
 @emph{Note:} A reminder that the wifi NetDevice is not yet supported
 (only CSMA and PointToPoint).
 
+It is possible to call this function again in the midst of a simulation
+using the following additional public function:
+@verbatim
+  GlobalRouteManager::RecomputeRoutingTables ();
+@end verbatim
+which flushes the old tables, queries the nodes for new interface information,
+and rebuilds the routes.
+
+For instance, this scheduling call will cause the tables to be rebuilt
+at time 5 seconds:
+@verbatim
+  Simulator::Schedule (Seconds (5),&GlobalRouteManager::RecomputeRoutingTables);
+@end verbatimT
+
 @node Global Routing Implementation
 @section Global Routing Implementation
 
--- a/doc/manual/sockets.texi	Fri Dec 12 14:52:16 2008 -0800
+++ b/doc/manual/sockets.texi	Fri Dec 12 17:18:29 2008 -0800
@@ -194,7 +194,7 @@
 @section POSIX-like sockets API 
 
 @emph{this capability is under development and is scheduled for
-inclusion in August 2008 timeframe; see the repository
+inclusion in the ns-3.5 releasetimeframe; see the repository
 http://code.nsnam.org/mathieu/ns-3-simu for details}
 
 The below is excerpted from Mathieu's post to ns-developers list
--- a/examples/dynamic-global-routing.cc	Fri Dec 12 14:52:16 2008 -0800
+++ b/examples/dynamic-global-routing.cc	Fri Dec 12 17:18:29 2008 -0800
@@ -42,29 +42,29 @@
 //  At time 1s, start CBR traffic flow from n1 to n6
 //  At time 2s, set the n1 point-to-point interface to down.  Packets
 //    will start to be dropped 
-//  At time 3s, call RecomputeGlobalRoutes() and traffic will
+//  At time 3s, call RecomputeRoutingTables() and traffic will
 //    start flowing again on the alternate path
 //  At time 4s, re-enable the n1/n6 interface to up.  Will not change routing
-//  At time 5s, call RecomputeGlobalRoutes() and traffic will start flowing 
+//  At time 5s, call RecomputeRoutingTables() and traffic will start flowing 
 //    again on the original path
 //  At time 6s, set the n6-n1 point-to-point Ipv4 interface to down (note, this
 //    keeps the point-to-point link "up" from n1's perspective).  Packets
 //    will traverse the link and be dropped at n6 upon receipt.  These drops
 //    are not visible in the pcap trace but in the ascii trace.
-//  At time 7s, call RecomputeGlobalRoutes() and traffic will flow again
+//  At time 7s, call RecomputeRoutingTables() and traffic will flow again
 //    through the path n1-n2-n5-n6
 //  At time 8s, bring the interface back up.
-//  At time 9s, call RecomputeGlobalRoutes() and traffic will flow again
+//  At time 9s, call RecomputeRoutingTables() and traffic will flow again
 //    through the path n1-n6
 //  At time 10s, stop the first flow.  
 //  At time 11s, start a new flow, but to n6's other IP address (the one
 //    on the n1/n6 p2p link)
 //  At time 12s, bring the n1 interface down between n1 and n6.  Packets
 //    will start to be dropped 
-//  At time 13s, call RecomputeGlobalRoutes() and traffic will
+//  At time 13s, call RecomputeRoutingTables() and traffic will
 //    start flowing again on the alternate path
 //  At time 14s, re-enable the n1/n6 interface to up.  Will not change routing
-//  At time 15s, call RecomputeGlobalRoutes() and traffic will start flowing 
+//  At time 15s, call RecomputeRoutingTables() and traffic will start flowing 
 //    again on the original path
 //  At time 16s, stop the second flow.