src/core/core_api_peer_request.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010 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 2, 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 core/core_api_peer_request.c
  23  * @brief implementation of the peer_request functions
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet_core_service.h"
  28 #include "core.h"
  29
  30
  31 /**
  32  * Handle for a request to the core to connect to
  33  * a particular peer.  Can be used to cancel the request
  34  * (before the 'cont'inuation is called).
  35  */
  36 struct GNUNET_CORE_PeerRequestHandle
  37 {
  38
  39   /**
  40    * Our connection to the service.
  41    */
  42   struct GNUNET_CLIENT_Connection *client;
  43
  44   /**
  45    * Scheduler.
  46    */
  47   struct GNUNET_SCHEDULER_Handle *sched;
  48
  49   /**
  50    * Function to call once done.
  51    */
  52   GNUNET_SCHEDULER_Task cont;
  53
  54   /**
  55    * Closure for 'cont'.
  56    */
  57   void *cont_cls;
  58
  59   /**
  60    * Identity of the peer to connect to.
  61    */
  62   struct GNUNET_PeerIdentity peer;
  63
  64   /**
  65    * Message type to use.
  66    */
  67   uint16_t type;
  68 };
  69
  70
  71 /**
  72  * Transmit the request to the core service.
  73  *
  74  * @param cls our 'struct GNUNET_CORE_PeerRequestHandle'
  75  * @param size number of bytes available in buf
  76  * @param buf where the callee should write the message
  77  * @return number of bytes written to buf
  78  */
  79 static size_t
  80 send_request (void *cls,
  81               size_t size,
  82               void *buf)
  83 {
  84   struct GNUNET_CORE_PeerRequestHandle * prh = cls;
  85   struct ConnectMessage msg;
  86
  87   if (buf == NULL)
  88     {
  89       GNUNET_SCHEDULER_add_continuation (prh->sched,
  90                                          prh->cont,
  91                                          prh->cont_cls,
  92                                          GNUNET_SCHEDULER_REASON_TIMEOUT);
  93       GNUNET_CLIENT_disconnect (prh->client);
  94       GNUNET_free (prh);
  95       return 0;
  96     }
  97   GNUNET_assert (size >= sizeof (struct ConnectMessage));
  98   msg.header.type = htons (prh->type);
  99   msg.header.size = htons (sizeof (struct ConnectMessage));
 100   msg.reserved = htonl (0);
 101   msg.peer = prh->peer;
 102   memcpy (buf, &msg, sizeof (msg));
 103   GNUNET_SCHEDULER_add_continuation (prh->sched,
 104                                      prh->cont,
 105                                      prh->cont_cls,
 106                                      GNUNET_SCHEDULER_REASON_PREREQ_DONE);
 107   GNUNET_CLIENT_disconnect (prh->client);
 108   GNUNET_free (prh);
 109   return sizeof (msg);
 110 }
 111
 112
 113 /**
 114  * Request that the core should try to connect to a particular peer.
 115  * Once the request has been transmitted to the core, the continuation
 116  * function will be called.  Note that this does NOT mean that a
 117  * connection was successfully established -- it only means that the
 118  * core will now try.  Successful establishment of the connection
 119  * will be signalled to the 'connects' callback argument of
 120  * 'GNUNET_CORE_connect' only.  If the core service does not respond
 121  * to our connection attempt within the given time frame, 'cont' will
 122  * be called with the TIMEOUT reason code.
 123  *
 124  * @param sched scheduler to use
 125  * @param cfg configuration to use
 126  * @param timeout how long to try to talk to core
 127  * @param cont function to call once the request has been completed (or timed out)
 128  * @param cont_cls closure for cont
 129  * @return NULL on error (cont will not be called), otherwise handle for cancellation
 130  */
 131 struct GNUNET_CORE_PeerRequestHandle *
 132 GNUNET_CORE_peer_request_connect (struct GNUNET_SCHEDULER_Handle *sched,
 133                                   const struct GNUNET_CONFIGURATION_Handle *cfg,
 134                                   struct GNUNET_TIME_Relative timeout,
 135                                   const struct GNUNET_PeerIdentity * peer,
 136                                   GNUNET_SCHEDULER_Task cont,
 137                                   void *cont_cls)
 138 {
 139   struct GNUNET_CORE_PeerRequestHandle *ret;
 140   struct GNUNET_CLIENT_Connection *client;
 141
 142   client = GNUNET_CLIENT_connect (sched, "core", cfg);
 143   if (client == NULL)
 144     return NULL;
 145   ret = GNUNET_malloc (sizeof (struct GNUNET_CORE_PeerRequestHandle));
 146   ret->client = client;
 147   ret->sched = sched;
 148   ret->cont = cont;
 149   ret->cont_cls = cont_cls;
 150   ret->peer = *peer;
 151   ret->type = GNUNET_MESSAGE_TYPE_CORE_REQUEST_CONNECT;
 152   GNUNET_CLIENT_notify_transmit_ready (client,
 153                                        sizeof (struct ConnectMessage),
 154                                        timeout,
 155                                        GNUNET_YES,
 156                                        &send_request,
 157                                        ret);
 158   return ret;
 159 }
 160
 161
 162 /**
 163  * Cancel a pending request to connect to a particular peer.  Must not
 164  * be called after the 'cont' function was invoked.
 165  *
 166  * @param req request handle that was returned for the original request
 167  */
 168 void
 169 GNUNET_CORE_peer_request_connect_cancel (struct GNUNET_CORE_PeerRequestHandle *req)
 170 {
 171   GNUNET_CLIENT_disconnect (req->client);
 172   GNUNET_free (req);
 173 }
 174
 175
 176 /* end of core_api_peer_request.c */