- fix error messages

[oweals/gnunet.git] / src / transport / gnunet-service-transport_manipulation.h

diff --git a/src/transport/gnunet-service-transport_manipulation.h b/src/transport/gnunet-service-transport_manipulation.h
index c8e8b27e9453e8f13e6f6683295b3ee1ccfe1c75..4fe68ade16582bca2a042b67c2f8954f1ce93b9e 100644 (file)
--- a/src/transport/gnunet-service-transport_manipulation.h
+++ b/src/transport/gnunet-service-transport_manipulation.h
@@ -37,15 +37,46 @@
 #include "transport.h"
 
 
+/**
+ * Set traffic metric to manipulate
+ *
+ * @param cls closure
+ * @param client client sending message
+ * @param message containing information
+ */
+
 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,
@@ -55,30 +86,41 @@ GST_manipulation_recv (void *cls,
                                                                                         uint16_t sender_address_len);
 
 /**
- * Function that will be called to figure if an address is an loopback,
- * LAN, WAN etc. address
+ * Function that will be called to manipulate ATS information according to
+ * current manipulation settings
  *
- * @param cls closure
  * @param peer the peer
  * @param address binary address
- * @param address_len length of the address
  * @param session the session
  * @param ats the ats information
  * @param ats_count the number of ats information
  */
+struct GNUNET_ATS_Information *
+GST_manipulation_manipulate_metrics (const struct GNUNET_PeerIdentity *peer,
+               const struct GNUNET_HELLO_Address *address,
+               struct Session *session,
+               const struct GNUNET_ATS_Information *ats,
+               uint32_t ats_count);
+
+/**
+ * Notify manipulation about disconnect so it can discard queued messages
+ *
+ * @param peer the disconnecting peer
+ */
 void
-GST_manipulation_metrics_recv (void *cls,
-                                                                                                                                struct GNUNET_PeerIdentity *peer,
-                                                                                                                                const char *address,
-                                                                                                                                uint16_t address_len,
-                                                                                                                                struct Session *session,
-                                                                                                                                struct GNUNET_ATS_Information *ats,
-                                                                                                                                uint32_t ats_count);
+GST_manipulation_peer_disconnect (const struct GNUNET_PeerIdentity *peer);
 
+/**
+ * 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 ();