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  * After how long do we expire an address in a HELLO that we just
  36  * validated?  This value is also used for our own addresses when we
  37  * create a HELLO.
  38  */
  39 #define GST_HELLO_ADDRESS_EXPIRATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 12)
  40
  41
  42 /**
  43  * Signature of a function to call whenever our hello changes.
  44  *
  45  * @param cls closure
  46  * @param hello updated HELLO
  47  */
  48 typedef void (*GST_HelloCallback) (void *cls,
  49                                    const struct GNUNET_MessageHeader * hello);
  50
  51
  52 /**
  53  * Initialize the HELLO module.
  54  *
  55  * @param cb function to call whenever our HELLO changes
  56  * @param cb_cls closure for cb
  57  */
  58 void GST_hello_start (GST_HelloCallback cb, void *cb_cls);
  59
  60
  61 /**
  62  * Shutdown the HELLO module.
  63  */
  64 void GST_hello_stop (void);
  65
  66
  67 /**
  68  * Obtain this peers HELLO message.
  69  *
  70  * @return our HELLO message
  71  */
  72 const struct GNUNET_MessageHeader *GST_hello_get (void);
  73
  74
  75 /**
  76  * Add or remove an address from this peer's HELLO message.
  77  *
  78  * @param addremove GNUNET_YES to add, GNUNET_NO to remove
  79  * @param plugin_name name of the plugin for which this is an address
  80  * @param plugin_address address in a plugin-specific format
  81  * @param plugin_address_len number of bytes in plugin_address
  82  */
  83 void
  84 GST_hello_modify_addresses (int addremove,
  85                             const char *plugin_name,
  86                             const void *plugin_address,
  87                             size_t plugin_address_len);
  88
  89
  90 /**
  91  * Test if a particular address is one of ours.
  92  *
  93  * @param plugin_name name of the plugin for which this is an address
  94  * @param plugin_address address in a plugin-specific format
  95  * @param plugin_address_len number of bytes in plugin_address
  96  * @param sig location where to cache PONG signatures for this address [set]
  97  * @param sig_expiration how long until the current 'sig' expires?
  98  *            (ZERO if sig was never created) [set]
  99  * @return GNUNET_YES if this is one of our addresses,
 100  *         GNUNET_NO if not
 101  */
 102 int
 103 GST_hello_test_address (const char *plugin_name,
 104                         const void *plugin_address,
 105                         size_t plugin_address_len,
 106                         struct GNUNET_CRYPTO_RsaSignature **sig,
 107                         struct GNUNET_TIME_Absolute **sig_expiration);
 108
 109
 110 #endif
 111 /* end of file gnunet-service-transport_hello.h */