some slips of the keyboard in tutorial
authorCraig Dowell <craigdo@ee.washington.edu>
Thu, 03 Jul 2008 20:03:03 -0700
changeset 3383 f21d3d5926b9
parent 3382 d5f8e5fae1c6
child 3384 11747ae5b632
child 3450 73e90de6eb47
some slips of the keyboard in tutorial
doc/tutorial/conceptual-overview.texi
--- a/doc/tutorial/conceptual-overview.texi	Thu Jul 03 17:37:32 2008 -0700
+++ b/doc/tutorial/conceptual-overview.texi	Thu Jul 03 20:03:03 2008 -0700
@@ -575,7 +575,7 @@
 The first line of code in the above snippet declares the 
 @code{UdpEchoServerHelper}.  As usual, this isn't the application itself, it
 is an object used to help us create the actual applications.  One of our 
-conventions is place required attributes in the helper constructor.  In this
+conventions is to place required attributes in the helper constructor.  In this
 case, the helper can't do anything useful unless it is provided with a port
 number that the client also knows about.  Rather than just picking one and
 hoping it all works out, we require the port number as a parameter to the 
@@ -624,32 +624,32 @@
 that is managed by an @code{UdpEchoClientHelper}.
 
 @verbatim
-    UdpEchoClientHelper echoClient;
-    echoClient.SetRemote (interfaces.GetAddress (1), 9);
-    echoClient.SetAppAttribute ("MaxPackets", UintegerValue (1));
-    echoClient.SetAppAttribute ("Interval", TimeValue (Seconds (1.)));
-    echoClient.SetAppAttribute ("PacketSize", UintegerValue (1024));
+    UdpEchoClientHelper echoClient (interfaces.GetAddress (1), 9);
+    echoClient.SetAttribute ("MaxPackets", UintegerValue (1));
+    echoClient.SetAttribute ("Interval", TimeValue (Seconds (1.)));
+    echoClient.SetAttribute ("PacketSize", UintegerValue (1024));
 
     ApplicationContainer clientApps = echoClient.Install (nodes.Get (0));
     clientApps.Start (Seconds (2.0));
     clientApps.Stop (Seconds (10.0));
 @end verbatim
 
-For the echo client, however, we need to set four different attributes.  The 
-first attribute is set using the @code{SetRemote} method.  Recall that
-we used an @code{Ipv4InterfaceContainer} to keep track of the IP addresses we
-assigned to our devices.  The zeroth interface in the @code{interfaces} 
-container is going to coorespond to the IP address of the zeroth node in the 
-@code{nodes} container.  The first interface in the @code{interfaces} 
-container cooresponds to the IP address of the first node in the @code{nodes} 
-container.  So, in the following line of code (reproduced from above), we are 
-setting the remote address of the client to be the IP address assigned to the
-node on which the server resides.  We also tell it to send packets to port 
-nine while we are at ti.
+For the echo client, however, we need to set five different attributes.  The 
+first two attributes are set during construction of the 
+@code{UdpEchoClientHelper}.  We pass parameters that are used (internally to
+the helper) to set the ``RemoteAddress'' and ``RemotePort'' attributes in
+accordance with our convention to make required attributes parameters in the 
+helper constructors.  
 
-@verbatim
-    echoClient.SetRemote (interfaces.GetAddress (1), 9);
-@end verbatim
+Recall that we used an @code{Ipv4InterfaceContainer} to keep track of the IP 
+addresses we assigned to our devices.  The zeroth interface in the 
+@code{interfaces} container is going to coorespond to the IP address of the 
+zeroth node in the @code{nodes} container.  The first interface in the 
+@code{interfaces} container cooresponds to the IP address of the first node 
+in the @code{nodes} container.  So, in the first line of code (from above), we
+are creating the helper and telling it so set the remote address of the client
+to be  the IP address assigned to the node on which the server resides.  We 
+also tell it to arrange to send packets to port nine.
 
 The ``MaxPackets'' attribute tells the client the maximum number of packets 
 we allow it to send during the simulation.  The ``Interval'' attribute tells