[hipl-commit] [trunk] Rev 3616: Doxygen for firewall/lsi.c

From: Miika Komu <miika@xxxxxx>
To: hipl-commit@xxxxxxxxxxxxx
Date: Thu, 11 Feb 2010 20:25:13 +0200
Committer: Miika Komu <miika@xxxxxx>
Date: Thu Feb 11 20:25:12 2010 +0200
Revision: 3616
Revision-id: miika@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Branch nick: trunk

Log:
  Doxygen for firewall/lsi.c

Modified:
  M  firewall/lsi.c

=== modified file 'firewall/lsi.c'
--- firewall/lsi.c      2010-02-11 09:57:04 +0000
+++ firewall/lsi.c      2010-02-11 18:25:12 +0000
@@ -1,3 +1,27 @@
+/**
+ * @file firewall/lsi.c
+ *
+ * Distributed under <a href="http://www.gnu.org/licenses/gpl2.txt";>GNU/GPL</a>
+ *
+ * This file provides translation between HITs and LSIs. Outgoing
+ * LSI-based packets are all captured, translated to HIT-based packets
+ * and reinjected back to the networking stack for delivery. Incoming
+ * HIT-based packets are either passed as they are or translated to
+ * LSI-based packets depending on destination transport port. If there
+ * is an IPv6 application listening on the destination port, the
+ * packet is passed as it is. Otherwise, the packet is translated to
+ * the corresponding LSIs. See the following document for more technical
+ * details:
+ * 
+ * <a href="http://hipl.hiit.fi/hipl/thesis_teresa_finez.pdf";>T. Finez,
+ * Backwards Compatibility Experimentation with Host Identity Protocol
+ * and Legacy Software and Networks , final project, December 2008</a>
+ *
+ * @brief Local-Scope Identifier (LSI) input and output processing 
+ *
+ * @author Teresa Finez
+ */
+
 /* required for s6_addr32 */
 #define _BSD_SOURCE
 
@@ -263,9 +287,20 @@
     return err;
 }
 
-/*
- * similar to the hip_request_peer_hit_from_hipd(...) function
- *
+/**
+ * Ask hipd the HIT of the peer corresponding to the give IP address. Works
+ * similarly to the hip_request_peer_hit_from_hipd() function.
+ *
+ * @param peer_ip IP address of the peer
+ * @param peer_hit write the HIT of the peer to this output variable
+ * @param local_hit local HIT being used
+ * @param src_tcp_port TCP source port
+ * @param dst_tcp_port TCP destination port
+ * @param fallback unused variable
+ * @param reject unused variable
+ *
+ * @note the TCP ports are relevant only for the TCP extensions for opp. mode
+ * @todo remove fallback and reject variables
  */
 int hip_request_peer_hit_from_hipd_at_firewall(const struct in6_addr *peer_ip,
                                                struct in6_addr *peer_hit,
[hipl-commit] [trunk] Rev 3616: Doxygen for firewall/lsi.c

Other related posts:
