[hipl-commit] [tiny] Rev 3620: Doxygen for hip_handle_i2_in_i2_sent.

  • From: Tim Just <tim.just@xxxxxxxxxxxxxx>
  • To: hipl-commit@xxxxxxxxxxxxx
  • Date: Fri, 5 Mar 2010 12:20:01 +0200

Committer: Tim Just <tim.just@xxxxxxxxxxxxxx>
Date: Fri Mar 05 11:19:45 2010 +0100
Revision: 3620
Revision-id: tim.just@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Branch nick: tiny

Log:
  Doxygen for hip_handle_i2_in_i2_sent.

Modified:
  M  hipd/input.c

=== modified file 'hipd/input.c'
--- hipd/input.c        2010-03-05 10:13:14 +0000
+++ hipd/input.c        2010-03-05 10:19:45 +0000
@@ -1289,8 +1289,23 @@
 #endif
     return err;
 }
-
 /**
+ * hip_handle_i2_in_i2_sent
+ *
+ * Checks wether the received I2 packet in state I2-SENT should be droppped, or
+ * not. If the packet should be dropped, the drop_packet flag is set to 1.
+ *
+ * @note See RFC5201, 4.4.2., Table 4 for details.
+ *
+ * @param packet_type The packet type of the control message (RFC 5201, 5.3.)
+ * @param ha_state The host association state (RFC 5201, 4.4.1.)
+ * @param *ctx The packet context containing a pointer to the received message,
+ *             a pointer to the outgoing message, source and destination
+ *             address, the ports and the corresponding entry from the host
+ *             association database.
+ *
+ * @return Success = 0,
+ *         Error   = -1
  *
  */
 int hip_handle_i2_in_i2_sent(const uint32_t packet_type,

Other related posts:

  • » [hipl-commit] [tiny] Rev 3620: Doxygen for hip_handle_i2_in_i2_sent. - Tim Just