summaryrefslogtreecommitdiff
path: root/src/transport/gnunet-service-transport_neighbours.h
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2015-02-03 13:20:17 +0000
committerChristian Grothoff <christian@grothoff.org>2015-02-03 13:20:17 +0000
commit2aeb9884df190077944584342157afd5d32d6c8a (patch)
treeb9f1fa15b0741be6b5af46c8f50945c1e3f0a82d /src/transport/gnunet-service-transport_neighbours.h
parent8116248c35c6a085c5f3143b30ac11dc4ae53d50 (diff)
document API, do not pass unused 'session' argument
Diffstat (limited to 'src/transport/gnunet-service-transport_neighbours.h')
-rw-r--r--src/transport/gnunet-service-transport_neighbours.h42
1 files changed, 31 insertions, 11 deletions
diff --git a/src/transport/gnunet-service-transport_neighbours.h b/src/transport/gnunet-service-transport_neighbours.h
index 710439b10..ee3a34a79 100644
--- a/src/transport/gnunet-service-transport_neighbours.h
+++ b/src/transport/gnunet-service-transport_neighbours.h
@@ -209,38 +209,58 @@ GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
/**
- * FIXME
+ * Track information about data we received from the
+ * given address (used to notify ATS about our utilization
+ * of allocated resources).
+ *
+ * @param address the address we got data from
+ * @param message the message we received (really only the size is used)
*/
void
GST_neighbours_notify_data_recv (const struct GNUNET_HELLO_Address *address,
- struct Session *session,
const struct GNUNET_MessageHeader *message);
/**
- * FIXME
+ * Track information about payload (useful data) we received from the
+ * given address (used to notify ATS about our utilization of
+ * allocated resources).
+ *
+ * @param address the address we got data from
+ * @param message the message we received (really only the size is used)
*/
void
GST_neighbours_notify_payload_recv (const struct GNUNET_HELLO_Address *address,
- struct Session *session,
const struct GNUNET_MessageHeader *message);
/**
- * FIXME
+ * Track information about data we transmitted using the given @a
+ * address and @a session (used to notify ATS about our utilization of
+ * allocated resources).
+ *
+ * @param address the address we transmitted data to
+ * @param session session we used to transmit data
+ * @param message the message we sent (really only the size is used)
*/
void
-GST_neighbours_notify_payload_sent (const struct GNUNET_PeerIdentity *peer,
- size_t size);
+GST_neighbours_notify_data_sent (const struct GNUNET_HELLO_Address *address,
+ struct Session *session,
+ size_t size);
/**
- * FIXME
+ * Track information about payload (useful data) we transmitted using the
+ * given address (used to notify ATS about our utilization of
+ * allocated resources).
+ *
+ * @param address the address we transmitted data to
+ * @param message the message we sent (really only the size is used)
*/
void
-GST_neighbours_notify_data_sent (const struct GNUNET_HELLO_Address *address,
- struct Session *session,
- size_t size);
+GST_neighbours_notify_payload_sent (const struct GNUNET_PeerIdentity *peer,
+ size_t size);
+
/**