docu

3 files changed, 67 insertions, 12 deletions

diff --git a/src/transport/gnunet-service-transport.c b/src/transport/gnunet-service-transport.c
index c8d688407..be0371a6a 100644
--- a/src/transport/gnunet-service-transport.c
+++ b/src/transport/gnunet-service-transport.c
@@ -692,7 +692,7 @@ key_generation_cb (void *cls,
   GST_blacklist_start (GST_server, GST_cfg, &GST_my_identity);
   GST_ats =
       GNUNET_ATS_scheduling_init (GST_cfg, &ats_request_address_change, NULL);
-  GST_manipulation_init (GST_cfg, &plugin_env_update_metrics);
+  GST_manipulation_init (GST_cfg);
   GST_plugins_load (&GST_manipulation_recv,
                     &plugin_env_address_change_notification,
                     &plugin_env_session_end,
diff --git a/src/transport/gnunet-service-transport_manipulation.c b/src/transport/gnunet-service-transport_manipulation.c
index e8f64f6cf..145ffc078 100644
--- a/src/transport/gnunet-service-transport_manipulation.c
+++ b/src/transport/gnunet-service-transport_manipulation.c
@@ -52,8 +52,6 @@ struct GST_ManipulationHandle
 {
         struct GNUNET_CONTAINER_MultiHashMap *peers;
 
-        GNUNET_TRANSPORT_UpdateAddressMetrics metric_update_cb;
-
         /**
          * General inbound delay
          */
@@ -290,6 +288,17 @@ send_delayed (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
         GNUNET_free (dqe);
 }
 
+
+/**
+ * Adapter function between transport's send function and transport plugins
+ *
+ * @param target the peer the message to send to
+ * @param msg the message received
+ * @param msg_size message size
+ * @param timeout timeout
+ * @param cont the continuation to call after sending
+ * @param cont_cls cls for continuation
+ */
 void
 GST_manipulation_send (const struct GNUNET_PeerIdentity *target, const void *msg,
     size_t msg_size, struct GNUNET_TIME_Relative timeout,
@@ -393,6 +402,19 @@ GST_manipulation_manipulate_metrics (const struct GNUNET_PeerIdentity *peer,
         return ats_new;
 }
 
+
+/**
+ * Adapter function between transport plugins and transport receive function
+ * manipulation delays for next send.
+ *
+ * @param cls the closure for transport
+ * @param peer the peer the message was received from
+ * @param message the message received
+ * @param session the session the message was received on
+ * @param sender_address the sender address
+ * @param sender_address_len the length of the sender address
+ * @return manipulated delay for next receive
+ */
 struct GNUNET_TIME_Relative
 GST_manipulation_recv (void *cls,
                 const struct GNUNET_PeerIdentity *peer,
@@ -426,12 +448,15 @@ GST_manipulation_recv (void *cls,
                 return m_delay;
 }
 
+
+/**
+ * Initialize traffic manipulation
+ *
+ * @param GST_cfg configuration handle
+ */
 void
-GST_manipulation_init (const struct GNUNET_CONFIGURATION_Handle *GST_cfg,
-                GNUNET_TRANSPORT_UpdateAddressMetrics metric_update_cb)
+GST_manipulation_init (const struct GNUNET_CONFIGURATION_Handle *GST_cfg)
 {
-        man_handle.metric_update_cb = metric_update_cb;
-
         if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (GST_cfg,
                         "transport", "MANIPULATE_DISTANCE_IN", &man_handle.distance_recv))
                 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Setting inbound distance_in to %u\n",
diff --git a/src/transport/gnunet-service-transport_manipulation.h b/src/transport/gnunet-service-transport_manipulation.h
index e9bfeddb6..091062459 100644
--- a/src/transport/gnunet-service-transport_manipulation.h
+++ b/src/transport/gnunet-service-transport_manipulation.h
@@ -41,11 +41,34 @@ void
 GST_manipulation_set_metric (void *cls, struct GNUNET_SERVER_Client *client,
     const struct GNUNET_MessageHeader *message);
 
+/**
+ * Adapter function between transport's send function and transport plugins
+ *
+ * @param target the peer the message to send to
+ * @param msg the message received
+ * @param msg_size message size
+ * @param timeout timeout
+ * @param cont the continuation to call after sending
+ * @param cont_cls cls for continuation
+ */
 void
-GST_manipulation_send (const struct GNUNET_PeerIdentity *target, const void *msg,
-    size_t msg_size, struct GNUNET_TIME_Relative timeout,
-    GST_NeighbourSendContinuation cont, void *cont_cls);
+GST_manipulation_send (const struct GNUNET_PeerIdentity *target,
+                                                                                         const void *msg, size_t msg_size,
+                                                                                         struct GNUNET_TIME_Relative timeout,
+                                                                                         GST_NeighbourSendContinuation cont, void *cont_cls);
 
+/**
+ * Adapter function between transport plugins and transport receive function
+ * manipulation delays for next send.
+ *
+ * @param cls the closure for transport
+ * @param peer the peer the message was received from
+ * @param message the message received
+ * @param session the session the message was received on
+ * @param sender_address the sender address
+ * @param sender_address_len the length of the sender address
+ * @return manipulated delay for next receive
+ */
 struct GNUNET_TIME_Relative
 GST_manipulation_recv (void *cls,
                                                                                          const struct GNUNET_PeerIdentity *peer,
@@ -71,10 +94,17 @@ GST_manipulation_manipulate_metrics (const struct GNUNET_PeerIdentity *peer,
                 const struct GNUNET_ATS_Information *ats,
                 uint32_t ats_count);
 
+/**
+ * Initialize traffic manipulation
+ *
+ * @param GST_cfg configuration handle
+ */
 void
-GST_manipulation_init (const struct GNUNET_CONFIGURATION_Handle *GST_cfg,
-                GNUNET_TRANSPORT_UpdateAddressMetrics metric_update_cb);
+GST_manipulation_init (const struct GNUNET_CONFIGURATION_Handle *GST_cfg);
 
+/**
+ * Stop traffic manipulation
+ */
 void
 GST_manipulation_stop ();