Update error model and olsr doxygen

This commit is contained in:
Tom Henderson
2010-01-25 09:22:19 +01:00
parent bde7128578
commit 11da7ab680
2 changed files with 20 additions and 3 deletions

View File

@@ -45,7 +45,8 @@ class Packet;
* the packet is to be corrupted according to the underlying model.
* Depending on the error model, the packet itself may have its packet
* data buffer errored or not, or side information may be returned to
* the client in the form of a packet tag.
* the client in the form of a packet tag. (Note: No such error models
* that actually error the bits in a packet presently exist).
* The object can have state (resettable by Reset()).
* The object can also be enabled and disabled via two public member functions.
*
@@ -77,6 +78,9 @@ public:
virtual ~ErrorModel ();
/**
* Note: Depending on the error model, this function may or may not
* alter the contents of the packet upon returning true.
*
* \returns true if the Packet is to be considered as errored/corrupted
* \param pkt Packet to apply error model to
*/

View File

@@ -36,8 +36,6 @@
* Here is a summary of software's main features:
* - Mostly compliant with OLSR as documented in RFC 3626 (http://www.ietf.org/rfc/rfc3626.txt), with the following differences:
* - The use of multiple interfaces was not supported by the NS-2 version, but is supported in NS-3;
* - Unlike the NS-2 version, does not yet support MAC layer feedback as described in RFC 3626;
* - HNA (Host/Network Association) messages are almost-but-not-quite supported in this version.
*
* \section api API and Usage
*
@@ -53,6 +51,21 @@
* to set OLSR attributes. These include HelloInterval, TcInterval,
* MidInterval, Willingness. Other parameters are defined as macros
* in olsr-routing-protocol.cc.
*
* \section list Open Issues
*
* - OLSR does not repond to the routing event notifications correspondingg
* to dynamic interface up and down (RoutingProtocol::NotifyInterfaceUp and
* RoutingProtocol::NotifyInterfaceDown) or address insertion/removal
* (RoutingProtocol::NotifyAddAddress and
* RoutingProtocol::NotifyRemoveAddress).
* - HNA (Host/Network Association) messages are almost-but-not-quite supported in this version.
* - Unlike the NS-2 version, does not yet support MAC layer feedback as described in RFC 3626;
* - If a user binds a socket to a particular output device, OLSR will not
* consider that constraint in its route selection for locally originated
* packets
*
*
*/