fixup comments, nbr2 refactoring is now complete
authorHannes Gredler <hannes@gredler.at>
Fri, 29 May 2009 20:42:25 +0000 (22:42 +0200)
committerHannes Gredler <hannes@gredler.at>
Fri, 29 May 2009 20:42:25 +0000 (22:42 +0200)
src/neighbor_table.c
src/two_hop_neighbor_table.c
src/two_hop_neighbor_table.h

index f6d4741..7d3729b 100644 (file)
@@ -332,7 +332,7 @@ olsr_update_nbr_status(struct nbr_entry *entry, int lnk)
       struct nbr2_entry *two_hop_neighbor;
 
       /* Delete posible 2 hop entry on this neighbor */
-      if ((two_hop_neighbor = olsr_lookup_two_hop_neighbor_table(&entry->nbr_addr)) != NULL) {
+      if ((two_hop_neighbor = olsr_lookup_nbr2_entry(&entry->nbr_addr)) != NULL) {
         olsr_delete_nbr2_entry(two_hop_neighbor);
       }
 
index 5dae27a..8d6dfd3 100644 (file)
@@ -100,8 +100,13 @@ olsr_unlock_nbr2(struct nbr2_entry *nbr2)
   olsr_delete_nbr2_entry(nbr2);
 }
 
-/*
- * Lookup a neighbor list. 
+/**
+ * Lookup a neighbor list entry hanging off a nbr2 subtree. 
+ *
+ * @param nbr2 holding the root of the tree.
+ * @param addr the address of the one hop neighbor
+ *
+ * @return nada
  */
 static struct nbr_list_entry *
 olsr_lookup_nbr_list_entry(struct nbr2_entry *nbr2, const union olsr_ip_addr *addr)
@@ -116,14 +121,12 @@ olsr_lookup_nbr_list_entry(struct nbr2_entry *nbr2, const union olsr_ip_addr *ad
 }
 
 /**
- *Remove a one hop neighbor from a two hop neighbors
- *one hop list.
+ * Remove a one hop neighbor from a two hop neighbors one hop subtree.
  *
- *@param two_hop_entry the two hop neighbor to remove the
- *one hop neighbor from
- *@param address the address of the one hop neighbor to remove
+ * @param nbr2 the two hop neighbor to remove the one hop neighbor from
+ * @param addr the address of the one hop neighbor to remove
  *
- *@return nada
+ * @return nada
  */
 void
 olsr_delete_nbr_list_by_addr(struct nbr2_entry *nbr2, const union olsr_ip_addr *addr)
@@ -140,11 +143,10 @@ olsr_delete_nbr_list_by_addr(struct nbr2_entry *nbr2, const union olsr_ip_addr *
 }
 
 /**
- *Delete an entry from the two hop neighbor table.
- *
- *@param two_hop_neighbor the two hop neighbor to delete.
+ * Delete an entry from the two hop neighbor table.
  *
- *@return nada
+ * @param nbr2 the two hop neighbor to delete.
+ * @return nada
  */
 void
 olsr_delete_nbr2_entry(struct nbr2_entry *nbr2)
@@ -184,8 +186,7 @@ olsr_delete_nbr2_entry(struct nbr2_entry *nbr2)
 /**
  * Insert a new entry to the two hop neighbor table.
  *
- * @param two_hop_neighbor the entry to insert
- *
+ * @param addr the entry to insert
  * @return nada
  */
 struct nbr2_entry *
@@ -199,7 +200,7 @@ olsr_add_nbr2_entry(const union olsr_ip_addr *addr)
   /*
    * Check first if the entry exists.
    */
-  nbr2 = olsr_lookup_two_hop_neighbor_table(addr);
+  nbr2 = olsr_lookup_nbr2_entry(addr);
   if (nbr2) {
     return nbr2;
   }
@@ -221,12 +222,10 @@ olsr_add_nbr2_entry(const union olsr_ip_addr *addr)
   return nbr2;
 }
 
-
 /**
  * Lookup a neighbor2 entry in the neighbortable2 based on an address.
  *
  * @param addr the IP address of the neighbor to look up
- *
  * @return a pointer to the neighbor2 struct registered on the given
  *  address. NULL if not found.
  */
@@ -243,15 +242,15 @@ olsr_lookup_nbr2_entry_alias(const union olsr_ip_addr *addr)
 }
 
 /**
- *Look up an entry in the two hop neighbor table.
- *
- *@param dest the IP address of the entry to find
+ * Look up an entry in the two hop neighbor table.
+ * Unalias the passed in address before.
  *
- *@return a pointer to a nbr2_entry struct
- *representing the two hop neighbor
+ * @param dest the IP address of the entry to find
+ * @return a pointer to a nbr2_entry struct
+ *  representing the two hop neighbor
  */
 struct nbr2_entry *
-olsr_lookup_two_hop_neighbor_table(const union olsr_ip_addr *addr)
+olsr_lookup_nbr2_entry(const union olsr_ip_addr *addr)
 {
   const union olsr_ip_addr *main_addr;
 
@@ -296,8 +295,9 @@ olsr_add_nbr_list_entry(struct nbr_entry *nbr, struct nbr2_entry *nbr2)
 /**
  * Links a one-hop neighbor with a 2-hop neighbor.
  *
- * @param neighbor the 1-hop neighbor
- * @param two_hop_neighbor the 2-hop neighbor
+ * @param nbr  the 1-hop neighbor
+ * @param nbr2 the 2-hop neighbor
+ * @param vtime validity time of the 2hop neighbor
  * @return nada
  */
 void
@@ -307,9 +307,8 @@ olsr_link_nbr_nbr2(struct nbr_entry *nbr, struct nbr2_entry *nbr2, float vtime)
   olsr_add_nbr2_list_entry(nbr, nbr2, vtime);
 }
 
-
 /**
- *Print the two hop neighbor table to STDOUT.
 *Print the two hop neighbor table to STDOUT.
  *
  *@return nada
  */
index 5506272..2534082 100644 (file)
@@ -107,7 +107,7 @@ void olsr_unlock_nbr2(struct nbr2_entry *);
 void olsr_delete_nbr_list_by_addr(struct nbr2_entry *, const union olsr_ip_addr *);
 void olsr_delete_nbr2_entry(struct nbr2_entry *);
 struct nbr2_entry *olsr_add_nbr2_entry(const union olsr_ip_addr *);
-struct nbr2_entry *olsr_lookup_two_hop_neighbor_table(const union olsr_ip_addr *);
+struct nbr2_entry *olsr_lookup_nbr2_entry(const union olsr_ip_addr *);
 struct nbr2_entry *olsr_lookup_nbr2_entry_alias(const union olsr_ip_addr *);
 void olsr_link_nbr_nbr2(struct nbr_entry *, struct nbr2_entry *, float);
 void olsr_print_two_hop_neighbor_table(void);