src/transport/gnunet-service-transport_hello.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2010,2011 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your 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      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 */
  18 /**
  19  * @file transport/gnunet-service-transport_hello.h
  20  * @brief hello API
  21  * @author Christian Grothoff
  22  */
  23 #ifndef GNUNET_SERVICE_TRANSPORT_HELLO_H
  24 #define GNUNET_SERVICE_TRANSPORT_HELLO_H
  25
  26 #include "gnunet_statistics_service.h"
  27 #include "gnunet_transport_service.h"
  28 #include "gnunet_util_lib.h"
  29 #include "gnunet_hello_lib.h"
  30
  31
  32 /**
  33  * Signature of a function to call whenever our hello changes.
  34  *
  35  * @param cls closure
  36  * @param hello updated HELLO
  37  */
  38 typedef void
  39 (*GST_HelloCallback) (void *cls,
  40                       const struct GNUNET_MessageHeader *hello);
  41
  42
  43 /**
  44  * Initialize the HELLO module.
  45  *
  46  * @param friend_only use a friend only hello
  47  * @param cb function to call whenever our HELLO changes
  48  * @param cb_cls closure for @a cb
  49  */
  50 void
  51 GST_hello_start (int friend_only,
  52                  GST_HelloCallback cb,
  53                  void *cb_cls);
  54
  55
  56 /**
  57  * Shutdown the HELLO module.
  58  */
  59 void
  60 GST_hello_stop (void);
  61
  62
  63 /**
  64  * Obtain this peers HELLO message.
  65  *
  66  * @return our HELLO message
  67  */
  68 const struct GNUNET_MessageHeader *
  69 GST_hello_get (void);
  70
  71
  72 /**
  73  * Add or remove an address from this peer's HELLO message.
  74  *
  75  * @param addremove #GNUNET_YES to add, #GNUNET_NO to remove
  76  * @param address address to add or remove
  77  */
  78 void
  79 GST_hello_modify_addresses (int addremove,
  80                             const struct GNUNET_HELLO_Address *address);
  81
  82
  83 /**
  84  * Test if a particular address is one of ours.
  85  *
  86  * @param address the address to test
  87  * @param sig location where to cache PONG signatures for this address [set]
  88  * @param sig_expiration how long until the current 'sig' expires?
  89  *            (ZERO if sig was never created) [set]
  90  * @return #GNUNET_YES if this is one of our addresses,
  91  *         #GNUNET_NO if not
  92  */
  93 int
  94 GST_hello_test_address (const struct GNUNET_HELLO_Address *address,
  95                         struct GNUNET_CRYPTO_EddsaSignature **sig,
  96                         struct GNUNET_TIME_Absolute **sig_expiration);
  97
  98
  99 #endif
 100 /* end of file gnunet-service-transport_hello.h */