Merge TinyOS 2.1.1 into master.

[tinyos-2.x.git] / tos / lib / net / ctp / CompareBit.nc

diff --git a/tos/lib/net/ctp/CompareBit.nc b/tos/lib/net/ctp/CompareBit.nc
index 3f9528d794685c4e86d5f5484527c0c6726d85ae..ddebdac648b9c17f3a51a0814eac96445c72e21b 100644 (file)
--- a/tos/lib/net/ctp/CompareBit.nc
+++ b/tos/lib/net/ctp/CompareBit.nc
@@ -25,8 +25,9 @@
  */
 
 /** Link estimator asks the routing engine if this entry
- * should be inserted into the neighbor table given the
- * white bit. The return value is the "pin bit" - if true
+ * should be inserted into the neighbor table if the
+ * white bit on a link is set but there is no room for the link
+ * on the link table. The return value is the "pin bit" - if true
  * insert into the neighbor table. In the reference implementation
  * the router will return true if the path through the source
  * will be better than a path through at least one current neighbor.
@@ -38,5 +39,6 @@
 interface CompareBit {
 
   /* should the source of this message be inserted into the neighbor table? */
-   event bool shouldInsert(message_t * ONE msg, void* COUNT_NOK(len) payload, uint8_t len, bool white_bit);
+  /* expect to be called only for links with the white bit set */
+   event bool shouldInsert(message_t * ONE msg, void* COUNT_NOK(len) payload, uint8_t len);
 }