src/transport/gnunet-service-transport_hello.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2010,2011 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file transport/gnunet-service-transport_hello.h
  23  * @brief hello API
  24  * @author Christian Grothoff
  25  */
  26 #ifndef GNUNET_SERVICE_TRANSPORT_HELLO_H
  27 #define GNUNET_SERVICE_TRANSPORT_HELLO_H
  28
  29 #include "gnunet_statistics_service.h"
  30 #include "gnunet_transport_service.h"
  31 #include "gnunet_util_lib.h"
  32
  33
  34 /**
  35  * Signature of a function to call whenever our hello changes.
  36  *
  37  * @param cls closure
  38  * @param hello updated HELLO
  39  */
  40 typedef void (*GST_HelloCallback)(void *cls,
  41                                   const struct GNUNET_MessageHeader *hello);
  42
  43
  44 /**
  45  * Initialize the HELLO module.
  46  *
  47  * @param cb function to call whenever our HELLO changes
  48  * @param cb_cls closure for cb
  49  */
  50 void
  51 GST_hello_start (GST_HelloCallback cb,
  52                  void *cb_cls);
  53
  54
  55 /**
  56  * Shutdown the HELLO module.
  57  */
  58 void
  59 GST_hello_stop (void);
  60
  61
  62 /**
  63  * Obtain this peers HELLO message.
  64  *
  65  * @return our HELLO message
  66  */
  67 const struct GNUNET_MessageHeader *
  68 GST_hello_get (void);
  69
  70
  71 /**
  72  * Add or remove an address from this peer's HELLO message.
  73  *
  74  * @param addremove GNUNET_YES to add, GNUNET_NO to remove
  75  * @param plugin_name name of the plugin for which this is an address
  76  * @param plugin_address address in a plugin-specific format
  77  * @param plugin_address_len number of bytes in plugin_address
  78  */
  79 void
  80 GST_hello_modify_addresses (int addremove,
  81                             const char *plugin_name,
  82                             const void *plugin_address,
  83                             size_t plugin_address_len);
  84
  85
  86 /**
  87  * Test if a particular address is one of ours.
  88  *
  89  * @param plugin_name name of the plugin for which this is an address
  90  * @param plugin_address address in a plugin-specific format
  91  * @param plugin_address_len number of bytes in plugin_address
  92  * @param sig location where to cache PONG signatures for this address [set]
  93  * @param sig_expiration how long until the current 'sig' expires?
  94  *            (ZERO if sig was never created) [set]
  95  * @return GNUNET_YES if this is one of our addresses,
  96  *         GNUNET_NO if not
  97  */
  98 int
  99 GST_hello_test_address (const char *plugin_name,
 100                         const void *plugin_address,
 101                         size_t plugin_address_len,
 102                         struct GNUNET_CRYPTO_RsaSignature **sig,
 103                         struct GNUNET_TIME_Absolute **sig_expiration);
 104
 105
 106 #endif
 107 /* end of file gnunet-service-transport_hello.h */