src/transport/transport_api_offer_hello.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2009-2013, 2016 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 /**
  22  * @file transport/transport_api_offer_hello.c
  23  * @brief library to offer HELLOs to transport service
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet_util_lib.h"
  28 #include "gnunet_hello_lib.h"
  29 #include "gnunet_protocols.h"
  30 #include "gnunet_transport_service.h"
  31
  32
  33 /**
  34  * Entry in linked list for all offer-HELLO requests.
  35  */
  36 struct GNUNET_TRANSPORT_OfferHelloHandle
  37 {
  38
  39   /**
  40    * Transport service handle we use for transmission.
  41    */
  42   struct GNUNET_MQ_Handle *mq;
  43
  44   /**
  45    * Function to call once we are done.
  46    */
  47   GNUNET_SCHEDULER_TaskCallback cont;
  48
  49   /**
  50    * Closure for @e cont
  51    */
  52   void *cls;
  53
  54 };
  55
  56
  57 /**
  58  * Done sending HELLO message to the service, notify application.
  59  *
  60  * @param cls the handle for the operation
  61  */
  62 static void
  63 finished_hello (void *cls)
  64 {
  65   struct GNUNET_TRANSPORT_OfferHelloHandle *ohh = cls;
  66
  67   if (NULL != ohh->cont)
  68     ohh->cont (ohh->cls);
  69   GNUNET_TRANSPORT_offer_hello_cancel (ohh);
  70 }
  71
  72
  73 /**
  74  * Offer the transport service the HELLO of another peer.  Note that
  75  * the transport service may just ignore this message if the HELLO is
  76  * malformed or useless due to our local configuration.
  77  *
  78  * @param cfg configuration
  79  * @param hello the hello message
  80  * @param cont continuation to call when HELLO has been sent,
  81  *      tc reason #GNUNET_SCHEDULER_REASON_TIMEOUT for fail
  82  *      tc reasong #GNUNET_SCHEDULER_REASON_READ_READY for success
  83  * @param cont_cls closure for @a cont
  84  * @return a `struct GNUNET_TRANSPORT_OfferHelloHandle` handle or NULL on failure,
  85  *      in case of failure @a cont will not be called
  86  *
  87  */
  88 struct GNUNET_TRANSPORT_OfferHelloHandle *
  89 GNUNET_TRANSPORT_offer_hello (const struct GNUNET_CONFIGURATION_Handle *cfg,
  90                               const struct GNUNET_MessageHeader *hello,
  91                               GNUNET_SCHEDULER_TaskCallback cont,
  92                               void *cont_cls)
  93 {
  94   struct GNUNET_TRANSPORT_OfferHelloHandle *ohh
  95     = GNUNET_new (struct GNUNET_TRANSPORT_OfferHelloHandle);
  96   struct GNUNET_MQ_Envelope *env;
  97   struct GNUNET_PeerIdentity peer;
  98
  99   if (GNUNET_OK !=
 100       GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) hello,
 101                            &peer))
 102   {
 103     GNUNET_break (0);
 104     GNUNET_free (ohh);
 105     return NULL;
 106   }
 107   ohh->mq = GNUNET_CLIENT_connect (cfg,
 108                                    "transport",
 109                                    NULL,
 110                                    NULL,
 111                                    ohh);
 112   if (NULL == ohh->mq)
 113   {
 114     GNUNET_free (ohh);
 115     return NULL;
 116   }
 117   ohh->cont = cont;
 118   ohh->cls = cont_cls;
 119   GNUNET_break (ntohs (hello->type) == GNUNET_MESSAGE_TYPE_HELLO);
 120   env = GNUNET_MQ_msg_copy (hello);
 121   GNUNET_MQ_notify_sent (env,
 122                          &finished_hello,
 123                          ohh);
 124   GNUNET_MQ_send (ohh->mq,
 125                   env);
 126   return ohh;
 127 }
 128
 129
 130 /**
 131  * Cancel the request to transport to offer the HELLO message
 132  *
 133  * @param ohh the handle for the operation to cancel
 134  */
 135 void
 136 GNUNET_TRANSPORT_offer_hello_cancel (struct GNUNET_TRANSPORT_OfferHelloHandle *ohh)
 137 {
 138   GNUNET_MQ_destroy (ohh->mq);
 139   GNUNET_free (ohh);
 140 }
 141
 142
 143 /* end of transport_api_offer_hello.c */