document API change
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Mon Aug 25 15:00:56 2008 -0700 (17 months ago)
changeset 3571fbf628eb3ca6
parent 3570 42988e5cce5e
child 3572 b822851cb95d
document API change
CHANGES.html
     1.1 --- a/CHANGES.html	Mon Aug 25 10:03:38 2008 -0700
     1.2 +++ b/CHANGES.html	Mon Aug 25 15:00:56 2008 -0700
     1.3 @@ -61,12 +61,38 @@
     1.4  <h2>changes to existing API:</h2>
     1.5  
     1.6  <ul>
     1.7 +<li>25-08-2008; changeset 
     1.8 +<a href="http://code.nsnam.org/ns-3-dev/rev/e5ab96db540e">e5ab96db540e</a></li>
     1.9 +<ul>
    1.10 +<li>
    1.11 +bug 273: constify packet pointers.<br>
    1.12 +The normal and the promiscuous receive callbacks of the NetDevice API
    1.13 +have been changed from:
    1.14 +<pre>
    1.15 +Callback<bool,Ptr<NetDevice>,Ptr<Packet>,uint16_t,const Address &>
    1.16 +Callback<bool,Ptr<NetDevice>, Ptr<Packet>, uint16_t,
    1.17 +         const Address &, const Address &, enum PacketType >
    1.18 +</pre>
    1.19 +to:
    1.20 +<pre>
    1.21 +Callback<bool,Ptr<NetDevice>,Ptr<const Packet>,uint16_t,const Address &>
    1.22 +Callback<bool,Ptr<NetDevice>, Ptr<const Packet>, uint16_t,
    1.23 +         const Address &, const Address &, enum PacketType >
    1.24 +</pre>
    1.25 +to avoid the kind of bugs reported in 
    1.26 +<a href="http://www.nsnam.org/bugzilla/show_bug.cgi?id=273">bug 273</a>.
    1.27 +Users who implement a subclass of the NetDevice base class need to change the signature
    1.28 +of their SetReceiveCallback and SetPromiscReceiveCallback methods.
    1.29 +</li>
    1.30 +</ul>
    1.31 +</li>
    1.32 +
    1.33 +
    1.34  <li>04-08-2008; changeset 
    1.35  <a href="http://code.nsnam.org/ns-3-dev/rev/cba7b2b80fe8">cba7b2b80fe8</a></li>
    1.36  <ul>
    1.37  <li>
    1.38 -Cleanup of MTU confusion and initialization in CsmaNetDevice
    1.39 -<pre>
    1.40 +Cleanup of MTU confusion and initialization in CsmaNetDevice<br>
    1.41  The MTU of the CsmaNetDevice defaulted to 65535.  This did not correspond with
    1.42  the expected MTU found in Ethernet-like devices.  Also there was not clear 
    1.43  documentation regarding which MTU was being set.  There are two MTU here, one
    1.44 @@ -77,13 +103,11 @@
    1.45  mode, MAC MTU and PHY MTU while keeping the three values consistent.  See the
    1.46  Doxygen of CsmaNetDevice::SetMaxPayloadLength for a detailed description of the
    1.47  issues and solution.
    1.48 -</pre>
    1.49  </li>
    1.50  </ul>
    1.51  </li>
    1.52 -</ul>
    1.53  
    1.54 -<ul>
    1.55 +
    1.56  <li>21-07-2008; changeset 
    1.57  <a href="
    1.58  http://code.nsnam.org/ns-3-dev/rev/99698bc858e8">99698bc858e8</a></li>
    1.59 @@ -112,9 +136,8 @@
    1.60  </li>
    1.61  </ul>
    1.62  </li>
    1.63 -</ul>
    1.64  
    1.65 -<ul>
    1.66 +
    1.67  <li>03-07-2008; changeset 
    1.68  <a href="http://code.nsnam.org/ns-3-dev/rev/d5f8e5fae1c6">d5f8e5fae1c6</a></li>
    1.69  <ul>
    1.70 @@ -144,9 +167,8 @@
    1.71  </li>
    1.72  </ul>
    1.73  </li>
    1.74 -</ul>
    1.75  
    1.76 -<ul>
    1.77 +
    1.78  <li>03-07-2008; changeset 
    1.79  <a href="
    1.80  http://code.nsnam.org/ns-3-dev/rev/3cdd9d60f7c7">3cdd9d60f7c7</a></li>
    1.81 @@ -181,7 +203,7 @@
    1.82  </ul>
    1.83  </li>
    1.84  </ul>
    1.85 -</li>
    1.86 +
    1.87  
    1.88  </body>
    1.89  </html>