Changes between Version 28 and Version 29 of OverSimDevelop

Timestamp:

Sep 10, 2009, 1:27:24 PM (15 years ago)

Author:

Ingmar Baumgart

Comment:

--

OverSimDevelop

@@ -188 +188 @@
 In order to route packets in a realistic way, the "length" parameter of the message should be set to an appropiate value. This is done manually by using the setBitLength(bits) or setByteLength(bytes) function when sending the message. Forgetting to set this value will default the length to a size of 0, potentially making measurements such as latencies less meaningful. 
 
-All messages can encapsulate any other message (just avoid recursivity!) by using the encapsulate() function. To decapsulate the message, use decapsulate(). To peek the encapsulated message without decapsulating it, use getEncapsulatedMsg(). The length of the message is automatically updated.
-
-Additionaly, each message that is created must be deleted exactly once. Messages that aren't deleted will cause memory leaks, and those that are deleted twice can cause a segmentation fault. It is the responsibility of the programmer to know when a message should be deleted.
+All messages can encapsulate any other message by using the encapsulate() function. To decapsulate the message, use decapsulate(). To peek the encapsulated message without decapsulating it, use getEncapsulatedMsg(). The length of the message is automatically updated.
+
+Additionally, each message that is created must be deleted exactly once. Messages that aren't deleted will cause memory leaks, and those that are deleted twice can cause a segmentation fault. It is the responsibility of the programmer to know when a message should be deleted.
 
 == 4. Implementing the overlay and application modules ==
@@ -196 +196 @@
 In this section, we'll implement our overlay and application. But first, let's do a introduction about some of the important variable types used in !OverSim.
 
-BaseOverlay:        Template overlay module class. All overlay modules should derive from it.[[BR]]
-BaseApp:            Template application module class. All application modules should derive from it.[[BR]]
-
-OverlayKey:         Class to describe overlay keys. Internally it stores the key as an bit array. [[BR]]
+* [http://www.oversim.org/chrome/site/doc/neddoc/oversim.common.BaseOverlay.html BaseOverlay]: Template overlay module class. All overlay modules should derive from it.[[BR]]
+* [http://www.oversim.org/chrome/site/doc/neddoc/oversim.common.BaseOverlay.html BaseApp]: Template application module class. All application modules should derive from it.[[BR]]
+* [http://www.oversim.org/chrome/site/doc/doxy/classOverlayKey.html OverlayKey]: Class to describe overlay keys. Internally it stores the key as an bit array. [[BR]]
                     Its value can be set in different ways when it's being initialized:[[BR]]
 {{{
@@ -211 +210 @@
                     OverlayKey operations include equality (==), order (<, >) and range (isBetween(key1, key2)).[[BR]]
 
-IPvXAddress:        Generic IP address, can contain either an IPv4 address (IPAddress) or an IPv6 address (IPv6Address).[[BR]]
-TransportAddress:   A structure containing bot an IPvXAddress (field "ip"), and a port (field "port").[[BR]]
-NodeHandle:         A child class of TransportAddress, additionaly contains an OverlayKey (field "key"). In overlay and application modules, the variable "thisNode" contains the NodeHandle value representing the host. However, in application modules the "key" field may not be set.[[BR]]
+* IPvXAddress:        Generic IP address, can contain either an IPv4 address (IPAddress) or an IPv6 address (IPv6Address).[[BR]]
+* [http://www.oversim.org/chrome/site/doc/doxy/classTransportAddress.html TransportAddress]:   A structure containing bot an IPvXAddress (field "ip"), and a port (field "port").[[BR]]
+* [http://www.oversim.org/chrome/site/doc/doxy/classNodeHandle.html NodeHandle]:         A child class of TransportAddress, additionaly contains an OverlayKey (field "key"). In overlay and application modules, the variable "thisNode" contains the NodeHandle value representing the host. However, in application modules the "key" field may not be set.[[BR]]
 
 Now, let's continue with the implementation.
@@ -333 +332 @@
             myMessage->setByteLength(100);                   // set the message length to 100 bytes
 
-            numSent++;                                       // update statistics
+            RECORDS_STATS(numSent++);                        // update statistics
 
             callRoute(randomKey, myMessage); // send it to the overlay
@@ -373 +372 @@
 
     if (myMsg && myMsg->getType() == MYMSG_PONG) {
-       numReceived++;
+       RECORD_STATS(numReceived++);
     }