new fragmentation API design - with retransmit

1 files changed, 78 insertions, 26 deletions

diff --git a/src/include/gnunet_fragmentation_lib.h b/src/include/gnunet_fragmentation_lib.h
index 5c08b2f69..b2ba064f8 100644
--- a/src/include/gnunet_fragmentation_lib.h
+++ b/src/include/gnunet_fragmentation_lib.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet
-     (C) 2009 Christian Grothoff (and other contributing authors)
+     (C) 2009, 2011 Christian Grothoff (and other contributing authors)
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -26,7 +26,8 @@
 #ifndef GNUNET_FRAGMENTATION_LIB_H
 #define GNUNET_FRAGMENTATION_LIB_H
 
-#include "gnunet_common.h"
+#include "gnunet_util_lib.h"
+#include "gnunet_bandwidth_lib.h"
 #include "gnunet_statistics_service.h"
 
 #ifdef __cplusplus
@@ -37,6 +38,13 @@ extern "C"
 #endif
 #endif
 
+
+/**
+ * Fragmentation context.
+ */
+struct GNUNET_FRAGMENT_Context;
+
+
 /**
  * Function that is called with messages
  * created by the fragmentation module.
@@ -45,61 +53,105 @@ extern "C"
  * @param msg the message that was created
  */
 typedef void (*GNUNET_FRAGMENT_MessageProcessor) (void *cls,
-                                                  const struct
-                                                  GNUNET_MessageHeader * msg);
+                                                  const struct GNUNET_MessageHeader *msg);
 
 
 /**
- * Fragment an over-sized message.
+ * Create a fragmentation context for the given message.
+ * Fragments the message into fragments of size "mtu" or
+ * less.  Calls 'proc' on each un-acknowledged fragment,
+ * using both the expected 'delay' between messages and
+ * acknowledgements and the given 'tracker' to guide the
+ * frequency of calls to 'proc'.
  *
+ * @param stats statistics context
+ * @param mtu the maximum message size for each fragment
+ * @param tracker bandwidth tracker to use for flow control (can be NULL)
+ * @param delay expected delay between fragment transmission
+ *              and ACK based on previous messages
  * @param msg the message to fragment
- * @param mtu the maximum message size
- * @param proc function to call for each fragment
+ * @param proc function to call for each fragment to transmit
  * @param proc_cls closure for proc
+ * @return the fragmentation context
+ */
+struct GNUNET_FRAGMENT_Context *
+GNUNET_FRAGMENT_context_create (struct GNUNET_STATISTICS_Handle *stats,
+                                uint16_t mtu,
+                                struct GNUNET_BANDWIDTH_Tracker *tracker,
+                                struct GNUNET_TIME_Relative delay,
+                                const struct GNUNET_MessageHeader *msg,
+                                GNUNET_FRAGMENT_MessageProcessor proc,
+                                void *proc_cls);
+
+
+/**
+ * Process an acknowledgement message we got from the other
+ * side (to control re-transmits).
+ *
+ * @param fc fragmentation context
+ * @param msg acknowledgement message we received
+ * @return GNUNET_OK if this ack completes the work of the 'fc'
+ *                   (all fragments have been received);
+ *         GNUNET_NO if more messages are pending
+ *         GNUNET_SYSERR if this ack is not valid for this fc
  */
-void GNUNET_FRAGMENT_fragment (const struct GNUNET_MessageHeader *msg,
-                               uint16_t mtu,
-                               GNUNET_FRAGMENT_MessageProcessor proc,
-                               void *proc_cls);
+int GNUNET_FRAGMENT_process_ack (struct GNUNET_FRAGMENT_Context *fc,
+                                 const struct GNUNET_MessageHeader *msg);
+
+
+/**
+ * Destroy the given fragmentation context (stop calling 'proc', free
+ * resources).
+ *
+ * @param fc fragmentation context
+ * @return average delay between transmission and ACK for the
+ *         last message, FOREVER if the message was not fully transmitted
+ */
+struct GNUNET_TIME_Relative
+GNUNET_FRAGMENT_context_destroy (struct GNUNET_FRAGMENT_Context *fc);
+
 
 /**
  * Defragmentation context.
  */
-struct GNUNET_FRAGMENT_Context;
+struct GNUNET_DEFRAGMENT_Context;
+
 
 /**
  * Create a defragmentation context.
  *
  * @param stats statistics context
+ * @param cls closure for proc and ackp
  * @param proc function to call with defragmented messages
- * @param proc_cls closure for proc
+ * @param ackp function to call with acknowledgements (to send
+ *             back to the other side)
  * @return the defragmentation context
  */
-struct GNUNET_FRAGMENT_Context *GNUNET_FRAGMENT_context_create (struct
-                                                                GNUNET_STATISTICS_Handle
-                                                                *stats,
-                                                                GNUNET_FRAGMENT_MessageProcessor
-                                                                proc,
-                                                                void
-                                                                *proc_cls);
+struct GNUNET_DEFRAGMENT_Context *
+GNUNET_DEFRAGMENT_context_create (struct GNUNET_STATISTICS_Handle *stats,
+                                  void *cls,
+                                  GNUNET_FRAGMENT_MessageProcessor proc,
+                                  GNUNET_FRAGMENT_MessageProcessor ackp);
 
 
 /**
  * Destroy the given defragmentation context.
+ *
+ * @param dc defragmentation context
  */
-void GNUNET_FRAGMENT_context_destroy (struct GNUNET_FRAGMENT_Context *ctx);
+void
+GNUNET_DEFRAGMENT_context_destroy (struct GNUNET_DEFRAGMENT_Context *dc);
 
 
 /**
  * We have received a fragment.  Process it.
  *
- * @param ctx the context
- * @param sender who transmitted the fragment
+ * @param dc the context
  * @param msg the message that was received
  */
-void GNUNET_FRAGMENT_process (struct GNUNET_FRAGMENT_Context *ctx,
-                              const struct GNUNET_PeerIdentity *sender,
-                              const struct GNUNET_MessageHeader *msg);
+void
+GNUNET_DEFRAGMENT_process_fragment (struct GNUNET_DEFRAGMENT_Context *dc,
+                                    const struct GNUNET_MessageHeader *msg);
 
 
 #if 0                           /* keep Emacsens' auto-indent happy */