-changing exit helper code to automatically do the network configuration for an exit...
[oweals/gnunet.git] / src / transport / gnunet-service-transport_hello.h
index 75fef07aef5c82a69793b07f15c7abdb84e2ddde..605d19861da8f7cff055c2ca0dcbcaf44cd177a0 100644 (file)
 #include "gnunet_statistics_service.h"
 #include "gnunet_transport_service.h"
 #include "gnunet_util_lib.h"
+#include "gnunet_hello_lib.h"
+
 
 
 /**
+ * Signature of a function to call whenever our hello changes.
  *
+ * @param cls closure
+ * @param hello updated HELLO
  */
-void 
-GST_hello_start (void);
+typedef void (*GST_HelloCallback) (void *cls,
+                                   const struct GNUNET_MessageHeader * hello);
+
 
 /**
+ * Initialize the HELLO module.
  *
+ * @param cb function to call whenever our HELLO changes
+ * @param cb_cls closure for cb
+ */
+void
+GST_hello_start (GST_HelloCallback cb, void *cb_cls);
+
+
+/**
+ * Shutdown the HELLO module.
  */
 void
 GST_hello_stop (void);
 
+
 /**
+ * Obtain this peers HELLO message.
  *
+ * @return our HELLO message
  */
 const struct GNUNET_MessageHeader *
 GST_hello_get (void);
 
+
 /**
+ * Add or remove an address from this peer's HELLO message.
  *
+ * @param addremove GNUNET_YES to add, GNUNET_NO to remove
+ * @param address address to add or remove
  */
 void
 GST_hello_modify_addresses (int addremove,
-                           const char *plugin_name,
-                           const void *plugin_address,
-                           size_t plugin_address_len);
+                            const struct GNUNET_HELLO_Address *address);
+
 
 /**
+ * Test if a particular address is one of ours.
  *
+ * @param address the address to test
+ * @param sig location where to cache PONG signatures for this address [set]
+ * @param sig_expiration how long until the current 'sig' expires?
+ *            (ZERO if sig was never created) [set]
+ * @return GNUNET_YES if this is one of our addresses,
+ *         GNUNET_NO if not
  */
 int
-GST_hello_test_address (const char *plugin_name,
-                       const void *plugin_address,
-                       size_t plugin_address_len);
+GST_hello_test_address (const struct GNUNET_HELLO_Address *address,
+                        struct GNUNET_CRYPTO_RsaSignature **sig,
+                        struct GNUNET_TIME_Absolute **sig_expiration);
 
 
 #endif