- fix error messages

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

diff --git a/src/transport/gnunet-service-transport_blacklist.h b/src/transport/gnunet-service-transport_blacklist.h
index 92f81a2e93f64e647aedbf18f97e77d6384647bb..a0ae5a959cbce7f9e4386db55b0db60b0942c99d 100644 (file)
--- a/src/transport/gnunet-service-transport_blacklist.h
+++ b/src/transport/gnunet-service-transport_blacklist.h
@@ -1,10 +1,10 @@
 /*
      This file is part of GNUnet.
-     (C) 2010 Christian Grothoff (and other contributing authors)
+     (C) 2010,2011 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
-     by the Free Software Foundation; either version 2, or (at your
+     by the Free Software Foundation; either version 3, or (at your
      option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
@@ -20,62 +20,114 @@
 
 /**
  * @file transport/gnunet-service-transport_blacklist.h
- * @brief internal API for blacklisting functionality
+ * @brief blacklisting API
  * @author Christian Grothoff
  */
 #ifndef GNUNET_SERVICE_TRANSPORT_BLACKLIST_H
 #define GNUNET_SERVICE_TRANSPORT_BLACKLIST_H
 
-#include "gnunet_protocols.h"
-#include "gnunet_service_lib.h"
-#include "transport.h"
+#include "gnunet_statistics_service.h"
+#include "gnunet_util_lib.h"
 
 /**
- * Handle a request to blacklist a peer.
+ * Start blacklist subsystem.
  *
- * @param cls closure (always NULL)
- * @param client identification of the client
- * @param message the actual message
+ * @param server server used to accept clients from
+ * @param cfg configuration handle
+ * @param my_id my peer id
  */
 void
-GNUNET_TRANSPORT_handle_blacklist (void *cls,
-                                  struct GNUNET_SERVER_Client *client,
-                                  const struct GNUNET_MessageHeader *message);
+GST_blacklist_start (struct GNUNET_SERVER_Handle *server,
+                                                                                const struct GNUNET_CONFIGURATION_Handle *cfg,
+                                                                                const struct GNUNET_PeerIdentity *my_id);
 
 
 /**
- * Handle a request for notification of blacklist changes.
+ * Stop blacklist subsystem.
+ */
+void
+GST_blacklist_stop (void);
+
+
+/**
+ * Initialize a blacklisting client.  We got a blacklist-init
+ * message from this client, add him to the list of clients
+ * to query for blacklisting.
+ *
+ * @param cls unused
+ * @param client the client
+ * @param message the blacklist-init message that was sent
+ */
+void
+GST_blacklist_handle_init (void *cls, struct GNUNET_SERVER_Client *client,
+                           const struct GNUNET_MessageHeader *message);
+
+
+/**
+ * A blacklisting client has sent us reply. Process it.
+ *
+ * @param cls unused
+ * @param client the client
+ * @param message the blacklist-init message that was sent
+ */
+void
+GST_blacklist_handle_reply (void *cls, struct GNUNET_SERVER_Client *client,
+                            const struct GNUNET_MessageHeader *message);
+
+
+/**
+ * Add the given peer to the blacklist (for the given transport).
  *
- * @param cls closure (always NULL)
- * @param client identification of the client
- * @param message the actual message
+ * @param peer peer to blacklist
+ * @param transport_name transport to blacklist for this peer, NULL for all
  */
 void
-GNUNET_TRANSPORT_handle_blacklist_notify (void *cls,
-                                         struct GNUNET_SERVER_Client *client,
-                                         const struct GNUNET_MessageHeader *message);
+GST_blacklist_add_peer (const struct GNUNET_PeerIdentity *peer,
+                        const char *transport_name);
 
 
 /**
- * Is the given peer currently blacklisted?
+ * Handle to an active blacklist check.
+ */
+struct GST_BlacklistCheck;
+
+
+/**
+ * Continuation called from a blacklist test.
  *
- * @param id identity of the peer
- * @return GNUNET_YES if the peer is blacklisted, GNUNET_NO if not
+ * @param cls closure
+ * @param peer identity of peer that was tested
+ * @param result GNUNET_OK if the connection is allowed,
+ *               GNUNET_NO if not
  */
-int
-GNUNET_TRANSPORT_blacklist_check (const struct GNUNET_PeerIdentity *id);
+typedef void (*GST_BlacklistTestContinuation) (void *cls,
+                                               const struct GNUNET_PeerIdentity
+                                               * peer, int result);
 
 
 /**
- * Initialize the blacklisting subsystem.
+ * Test if a peer/transport combination is blacklisted.
  *
- * @param server server we handle requests from (transport service server)
- * @param s scheduler to use
+ * @param peer the identity of the peer to test
+ * @param transport_name name of the transport to test, never NULL
+ * @param cont function to call with result
+ * @param cont_cls closure for 'cont'
+ * @return handle to the blacklist check, NULL if the decision
+ *        was made instantly and 'cont' was already called
  */
-void 
-GNUNET_TRANSPORT_blacklist_init (struct GNUNET_SERVER_Handle *server,
-                                struct GNUNET_SCHEDULER_Handle *s);
+struct GST_BlacklistCheck *
+GST_blacklist_test_allowed (const struct GNUNET_PeerIdentity *peer,
+                            const char *transport_name,
+                            GST_BlacklistTestContinuation cont, void *cont_cls);
+
 
+/**
+ * Cancel a blacklist check.
+ *
+ * @param bc check to cancel
+ */
+void
+GST_blacklist_test_cancel (struct GST_BlacklistCheck *bc);
 
 #endif
-/* end of gnunet-service-transport_blacklist.h */
+/* end of file gnunet-service-transport_blacklist.h */