-improve indentation, reduce duplication of PIDs in core's neighbour map

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

diff --git a/src/transport/gnunet-service-transport_neighbours.h b/src/transport/gnunet-service-transport_neighbours.h
index 093bd06e19b7744905b68c163828f6388be667b1..8d2139d94dc5025fcf8eaebbdadb80f08057658f 100644 (file)
--- a/src/transport/gnunet-service-transport_neighbours.h
+++ b/src/transport/gnunet-service-transport_neighbours.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2010-2015 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2010-2015 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
@@ -14,8 +14,8 @@
 
      You should have received a copy of the GNU General Public License
      along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 
 /**
@@ -102,27 +102,6 @@ GST_neighbours_send (const struct GNUNET_PeerIdentity *target,
                      GST_NeighbourSendContinuation cont, void *cont_cls);
 
 
-
-/**
- * FIXME
- */
-void
-GST_neighbours_register_quota_notification (void *cls,
-                                           const struct GNUNET_PeerIdentity *peer,
-                                           const char *plugin,
-                                           struct Session *session);
-
-
-/**
- * FIXME
- */
-void
-GST_neighbours_unregister_quota_notification (void *cls,
-                                              const struct GNUNET_PeerIdentity *peer,
-                                              const char *plugin,
-                                              struct Session *session);
-
-
 /**
  * We have received a message from the given sender.
  * How long should we delay before receiving more?
@@ -230,33 +209,26 @@ 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
- */
-void
-GST_neighbours_notify_payload_recv (const struct GNUNET_HELLO_Address *address,
-                                    struct Session *session,
-                                    const struct GNUNET_MessageHeader *message);
-
-
-/**
- * FIXME
- */
-void
-GST_neighbours_notify_payload_sent (const struct GNUNET_PeerIdentity *peer,
-                                    size_t size);
-
-
-/**
- * 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_data_sent (const struct GNUNET_HELLO_Address *address,
@@ -325,24 +297,25 @@ GST_neighbours_handle_session_ack (const struct GNUNET_MessageHeader *message,
 
 
 /**
- * Obtain current latency information for the given neighbour.
+ * Obtain current address information for the given neighbour.
  *
  * @param peer
- * @return observed latency of the address, FOREVER if the address was
- *         never successfully validated
+ * @return address currently used
  */
-struct GNUNET_TIME_Relative
-GST_neighbour_get_latency (const struct GNUNET_PeerIdentity *peer);
+struct GNUNET_HELLO_Address *
+GST_neighbour_get_current_address (const struct GNUNET_PeerIdentity *peer);
 
 
 /**
- * Obtain current address information for the given neighbour.
+ * We received a quoat message from the given peer,
+ * validate and process.
  *
- * @param peer
- * @return address currently used
+ * @param peer sender of the message
+ * @param msg the quota message
  */
-struct GNUNET_HELLO_Address *
-GST_neighbour_get_current_address (const struct GNUNET_PeerIdentity *peer);
+void
+GST_neighbours_handle_quota_message (const struct GNUNET_PeerIdentity *peer,
+                                     const struct GNUNET_MessageHeader *msg);
 
 
 /**