implementing blacklist

1 files changed, 63 insertions, 5 deletions

diff --git a/src/transport/gnunet-service-transport_neighbours.h b/src/transport/gnunet-service-transport_neighbours.h
index c627e7e2f..914134ac5 100644
--- a/src/transport/gnunet-service-transport_neighbours.h
+++ b/src/transport/gnunet-service-transport_neighbours.h
@@ -20,7 +20,7 @@
 
 /**
  * @file transport/gnunet-service-transport_neighbours.h
- * @brief plugin management API
+ * @brief neighbour management API
  * @author Christian Grothoff
  */
 #ifndef GNUNET_SERVICE_TRANSPORT_NEIGHBOURS_H
@@ -30,51 +30,93 @@
 #include "gnunet_transport_service.h"
 #include "gnunet_util_lib.h"
 
+// TODO:
+// - have a way to access the currently 'connected' session
+//   (for sending and to notice disconnect of it!)
+// - have a way to access/update bandwidth/quota information per peer
+//   (for CostReport/TrafficReport callbacks)
+
+
 
 /**
+ * Initialize the neighbours subsystem.
  *
+ * @param cls closure for callbacks
+ * @param connect_cb function to call if we connect to a peer
+ * @param disconnect_cb function to call if we disconnect from a peer
  */
 void 
 GST_neighbours_start (void *cls,
                       GNUNET_TRANSPORT_NotifyConnect connect_cb,
                       GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb);
 
+
 /**
- *
+ * Cleanup the neighbours subsystem.
  */
 void
 GST_neighbours_stop (void);
 
+
 /**
+ * Try to create a connection to the given target (eventually).
  *
+ * @param target peer to try to connect to
  */
 void
 GST_neighbours_try_connect (const struct GNUNET_PeerIdentity *target);
 
+
 /**
- *
+ * Test if we're connected to the given peer.
+ * 
+ * @param target peer to test
+ * @return GNUNET_YES if we are connected, GNUNET_NO if not
  */
 int
 GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target);
 
+
 /**
+ * If we have an active connection to the given target, it must be shutdown.
  *
+ * @param target peer to disconnect from
  */
 void
 GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target);
 
 
+/**
+ * Function called for each connected neighbour.
+ *
+ * @param cls closure
+ * @param neighbour identity of the neighbour
+ */
 typedef void (*GST_NeighbourIterator)(void *cls,
                                       const struct GNUNET_PeerIdentity *neighbour);
 
 
+/**
+ * Iterate over all connected neighbours.
+ *
+ * @param cb function to call 
+ * @param cb_cls closure for cb
+ */
 void
 GST_neighbours_iterate (GST_NeighbourIterator cb,
                         void *cb_cls);
 
 
 /**
+ * We have received a PONG.  Update lifeness of the neighbour.
  *
+ * @param sender peer sending the PONG
+ * @param hdr the PONG message (presumably)
+ * @param plugin_name name of transport that delivered the PONG
+ * @param sender_address address of the other peer, NULL if other peer
+ *                       connected to us
+ * @param sender_address_len number of bytes in sender_address
+ * @return GNUNET_OK if the message was well-formed, GNUNET_SYSERR if not
  */
 int
 GST_neighbours_handle_pong (const struct GNUNET_PeerIdentity *sender,
@@ -83,8 +125,17 @@ GST_neighbours_handle_pong (const struct GNUNET_PeerIdentity *sender,
                             const void *sender_address,
                             size_t sender_address_len);
 
+
 /**
+ * We have received a CONNECT.  Set the peer to connected.
  *
+ * @param sender peer sending the PONG
+ * @param hdr the PONG message (presumably)
+ * @param plugin_name name of transport that delivered the PONG
+ * @param sender_address address of the other peer, NULL if other peer
+ *                       connected to us
+ * @param sender_address_len number of bytes in sender_address
+ * @return GNUNET_OK if the message was well-formed, GNUNET_SYSERR if not
  */
 int
 GST_neighbours_handle_connect (const struct GNUNET_PeerIdentity *sender,
@@ -93,8 +144,17 @@ GST_neighbours_handle_connect (const struct GNUNET_PeerIdentity *sender,
                                const void *sender_address,
                                size_t sender_address_len);
 
+
 /**
+ * We have received a DISCONNECT.  Set the peer to disconnected.
  *
+ * @param sender peer sending the PONG
+ * @param hdr the PONG message (presumably)
+ * @param plugin_name name of transport that delivered the PONG
+ * @param sender_address address of the other peer, NULL if other peer
+ *                       connected to us
+ * @param sender_address_len number of bytes in sender_address
+ * @return GNUNET_OK if the message was well-formed, GNUNET_SYSERR if not
  */
 int
 GST_neighbours_handle_disconnect (const struct GNUNET_PeerIdentity *sender,
@@ -104,7 +164,5 @@ GST_neighbours_handle_disconnect (const struct GNUNET_PeerIdentity *sender,
                                   size_t sender_address_len);
 
 
-
-
 #endif
 /* end of file gnunet-service-transport_neighbours.h */