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      SPDX-License-Identifier: AGPL3.0-or-later
  19  */
  20 /**
  21  * @file transport/gnunet-service-transport_hello.h
  22  * @brief hello API
  23  * @author Christian Grothoff
  24  */
  25 #ifndef GNUNET_SERVICE_TRANSPORT_HELLO_H
  26 #define GNUNET_SERVICE_TRANSPORT_HELLO_H
  27
  28 #include "gnunet_statistics_service.h"
  29 #include "gnunet_transport_service.h"
  30 #include "gnunet_util_lib.h"
  31 #include "gnunet_hello_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
  41 (*GST_HelloCallback) (void *cls,
  42                       const struct GNUNET_MessageHeader *hello);
  43
  44
  45 /**
  46  * Initialize the HELLO module.
  47  *
  48  * @param friend_only use a friend only hello
  49  * @param cb function to call whenever our HELLO changes
  50  * @param cb_cls closure for @a cb
  51  */
  52 void
  53 GST_hello_start (int friend_only,
  54                  GST_HelloCallback cb,
  55                  void *cb_cls);
  56
  57
  58 /**
  59  * Shutdown the HELLO module.
  60  */
  61 void
  62 GST_hello_stop (void);
  63
  64
  65 /**
  66  * Obtain this peers HELLO message.
  67  *
  68  * @return our HELLO message
  69  */
  70 const struct GNUNET_MessageHeader *
  71 GST_hello_get (void);
  72
  73
  74 /**
  75  * Add or remove an address from this peer's HELLO message.
  76  *
  77  * @param addremove #GNUNET_YES to add, #GNUNET_NO to remove
  78  * @param address address to add or remove
  79  */
  80 void
  81 GST_hello_modify_addresses (int addremove,
  82                             const struct GNUNET_HELLO_Address *address);
  83
  84
  85 /**
  86  * Test if a particular address is one of ours.
  87  *
  88  * @param address the address to test
  89  * @param sig location where to cache PONG signatures for this address [set]
  90  * @param sig_expiration how long until the current 'sig' expires?
  91  *            (ZERO if sig was never created) [set]
  92  * @return #GNUNET_YES if this is one of our addresses,
  93  *         #GNUNET_NO if not
  94  */
  95 int
  96 GST_hello_test_address (const struct GNUNET_HELLO_Address *address,
  97                         struct GNUNET_CRYPTO_EddsaSignature **sig,
  98                         struct GNUNET_TIME_Absolute **sig_expiration);
  99
 100
 101 #endif
 102 /* end of file gnunet-service-transport_hello.h */