Small change in comments
[olsrd.git] / src / lq_plugin.c
index facb38a..23f2c95 100644 (file)
@@ -1,9 +1,50 @@
+/*
+ * The olsr.org Optimized Link-State Routing daemon(olsrd)
+ * Copyright (c) 2004, Thomas Lopatic (thomas@lopatic.de)
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without 
+ * modification, are permitted provided that the following conditions 
+ * are met:
+ *
+ * * Redistributions of source code must retain the above copyright 
+ *   notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright 
+ *   notice, this list of conditions and the following disclaimer in 
+ *   the documentation and/or other materials provided with the 
+ *   distribution.
+ * * Neither the name of olsr.org, olsrd nor the names of its 
+ *   contributors may be used to endorse or promote products derived 
+ *   from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Visit http://www.olsr.org for more information.
+ *
+ * If you find this software useful feel free to make a donation
+ * to the project. For more information see the website or contact
+ * the copyright holders.
+ *
+ */
+
 #include "tc_set.h"
 #include "link_set.h"
 #include "lq_route.h"
 #include "lq_packet.h"
 #include "packet.h"
 #include "olsr.h"
 #include "tc_set.h"
 #include "link_set.h"
 #include "lq_route.h"
 #include "lq_packet.h"
 #include "packet.h"
 #include "olsr.h"
+#include "two_hop_neighbor_table.h"
 
 #include "lq_plugin_default.h"
 #include "lq_plugin.h"
 
 #include "lq_plugin_default.h"
 #include "lq_plugin.h"
@@ -45,7 +86,7 @@ struct lq_handler *active_lq_handler = &default_lq_handler;
  * @param pointer to lq_handler structure
  * @param name of the link quality handler for debug output
  */
  * @param pointer to lq_handler structure
  * @param name of the link quality handler for debug output
  */
-void set_lq_handler(struct lq_handler *handler, char *name) {
+void set_lq_handler(struct lq_handler *handler, const char *name) {
   if (handler) {
     OLSR_PRINTF(1, "Activated lq_handler: %s\n", name);
     active_lq_handler = handler;
   if (handler) {
     OLSR_PRINTF(1, "Activated lq_handler: %s\n", name);
     active_lq_handler = handler;
@@ -196,10 +237,11 @@ void olsr_memorize_foreign_hello_lq(struct link_entry *local, struct hello_neigh
  * value in the same context (a single printf command for example).
  * 
  * @param pointer to link_entry
  * value in the same context (a single printf command for example).
  * 
  * @param pointer to link_entry
+ * @param buffer for output
  * @return pointer to a buffer with the text representation
  */
  * @return pointer to a buffer with the text representation
  */
-char *get_link_entry_text(struct link_entry *entry) {
-  return active_lq_handler->print_hello_lq(entry->linkquality);
+const char *get_link_entry_text(struct link_entry *entry, struct lqtextbuffer *buffer) {
+  return active_lq_handler->print_hello_lq(entry->linkquality, buffer);
 }
 
 /*
 }
 
 /*
@@ -210,13 +252,25 @@ char *get_link_entry_text(struct link_entry *entry) {
  * value in the same context (a single printf command for example).
  * 
  * @param pointer to tc_edge_entry
  * value in the same context (a single printf command for example).
  * 
  * @param pointer to tc_edge_entry
- * @return pointer to a buffer with the text representation
+ * @param pointer to buffer
+ * @return pointer to the buffer with the text representation
  */
  */
-char *get_tc_edge_entry_text(struct tc_edge_entry *entry) {
-  return active_lq_handler->print_tc_lq(entry->linkquality);
+const char *get_tc_edge_entry_text(struct tc_edge_entry *entry, struct lqtextbuffer *buffer) {
+  return active_lq_handler->print_tc_lq(entry->linkquality, buffer);
 }
 
 }
 
-const char *get_linkcost_text(olsr_linkcost cost, olsr_bool route) {
+/*
+ * get_linkcost_text
+ * 
+ * This function transforms an olsr_linkcost value into it's text representation and copies
+ * the result into a buffer.
+ * 
+ * @param linkcost value
+ * @param true to transform the cost of a route, false for a link
+ * @param pointer to buffer
+ * @return pointer to buffer filled with text
+ */
+const char *get_linkcost_text(olsr_linkcost cost, olsr_bool route, struct lqtextbuffer *buffer) {
   static const char *infinite = "INFINITE";
   
   if (route) {
   static const char *infinite = "INFINITE";
   
   if (route) {
@@ -229,7 +283,7 @@ const char *get_linkcost_text(olsr_linkcost cost, olsr_bool route) {
       return infinite;
     }
   }
       return infinite;
     }
   }
-  return active_lq_handler->print_cost(cost);
+  return active_lq_handler->print_cost(cost, buffer);
 }
 
 /*
 }
 
 /*