src/peerinfo/peerinfo_api.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2004, 2005, 2007, 2009, 2010, 2012 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 peerinfo/peerinfo_api.c
  23  * @brief API to access peerinfo service
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet_client_lib.h"
  28 #include "gnunet_container_lib.h"
  29 #include "gnunet_peerinfo_service.h"
  30 #include "gnunet_protocols.h"
  31 #include "gnunet_time_lib.h"
  32 #include "peerinfo.h"
  33
  34 #define LOG(kind,...) GNUNET_log_from (kind, "peerinfo-api",__VA_ARGS__)
  35
  36
  37 /**
  38  * Entry in the transmission queue to PEERINFO service.  We use
  39  * the same structure for queueing 'iteration' requests and
  40  * actual 'add' messages.
  41  */
  42 struct GNUNET_PEERINFO_AddContext
  43 {
  44   /**
  45    * This is a linked list.
  46    */
  47   struct GNUNET_PEERINFO_AddContext *next;
  48
  49   /**
  50    * This is a linked list.
  51    */
  52   struct GNUNET_PEERINFO_AddContext *prev;
  53
  54   /**
  55    * Handle to the PEERINFO service.
  56    */
  57   struct GNUNET_PEERINFO_Handle *h;
  58
  59   /**
  60    * Function to call after request has been transmitted, or NULL.
  61    */
  62   GNUNET_PEERINFO_Continuation cont;
  63
  64   /**
  65    * Closure for 'cont'.
  66    */
  67   void *cont_cls;
  68
  69   /**
  70    * Number of bytes of the request message (follows after this struct).
  71    */
  72   size_t size;
  73
  74 };
  75
  76
  77 /**
  78  * Context for an iteration request.
  79  */
  80 struct GNUNET_PEERINFO_IteratorContext
  81 {
  82
  83   /**
  84    * Kept in a DLL.
  85    */
  86   struct GNUNET_PEERINFO_IteratorContext *next;
  87
  88   /**
  89    * Kept in a DLL.
  90    */
  91   struct GNUNET_PEERINFO_IteratorContext *prev;
  92
  93   /**
  94    * Handle to the PEERINFO service.
  95    */
  96   struct GNUNET_PEERINFO_Handle *h;
  97
  98   /**
  99    * Function to call with the results.
 100    */
 101   GNUNET_PEERINFO_Processor callback;
 102
 103   /**
 104    * Closure for 'callback'.
 105    */
 106   void *callback_cls;
 107
 108   /**
 109    * Our entry in the transmission queue.
 110    */
 111   struct GNUNET_PEERINFO_AddContext *ac;
 112
 113   /**
 114    * Task responsible for timeout.
 115    */
 116   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
 117
 118   /**
 119    * Timeout for the operation.
 120    */
 121   struct GNUNET_TIME_Absolute timeout;
 122
 123   /**
 124    * Peer we are interested in (only valid if iteration was restricted to one peer).
 125    */
 126   struct GNUNET_PeerIdentity peer;
 127
 128   /**
 129    * Is 'peer' set?
 130    */
 131   int have_peer;
 132
 133   /**
 134    * Set to GNUNET_YES if we are currently receiving replies from the
 135    * service.
 136    */
 137   int request_transmitted;
 138
 139 };
 140
 141
 142 /**
 143  * Handle to the peerinfo service.
 144  */
 145 struct GNUNET_PEERINFO_Handle
 146 {
 147   /**
 148    * Our configuration.
 149    */
 150   const struct GNUNET_CONFIGURATION_Handle *cfg;
 151
 152   /**
 153    * Connection to the service.
 154    */
 155   struct GNUNET_CLIENT_Connection *client;
 156
 157   /**
 158    * Head of transmission queue.
 159    */
 160   struct GNUNET_PEERINFO_AddContext *ac_head;
 161
 162   /**
 163    * Tail of transmission queue.
 164    */
 165   struct GNUNET_PEERINFO_AddContext *ac_tail;
 166
 167   /**
 168    * Handle for the current transmission request, or NULL if none is pending.
 169    */
 170   struct GNUNET_CLIENT_TransmitHandle *th;
 171
 172   /**
 173    * Head of iterator DLL.
 174    */
 175   struct GNUNET_PEERINFO_IteratorContext *ic_head;
 176
 177   /**
 178    * Tail of iterator DLL.
 179    */
 180   struct GNUNET_PEERINFO_IteratorContext *ic_tail;
 181
 182   /**
 183    * ID for a reconnect task.
 184    */
 185   GNUNET_SCHEDULER_TaskIdentifier r_task;
 186
 187   /**
 188    * Are we now receiving?
 189    */
 190   int in_receive;
 191
 192 };
 193
 194
 195 /**
 196  * Connect to the peerinfo service.
 197  *
 198  * @param cfg configuration to use
 199  * @return NULL on error (configuration related, actual connection
 200  *         establishment may happen asynchronously).
 201  */
 202 struct GNUNET_PEERINFO_Handle *
 203 GNUNET_PEERINFO_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
 204 {
 205   struct GNUNET_PEERINFO_Handle *h;
 206
 207   h = GNUNET_malloc (sizeof (struct GNUNET_PEERINFO_Handle));
 208   h->client = GNUNET_CLIENT_connect ("peerinfo", cfg);
 209   h->cfg = cfg;
 210   return h;
 211 }
 212
 213
 214 /**
 215  * Disconnect from the peerinfo service.  Note that all iterators must
 216  * have completed or have been cancelled by the time this function is
 217  * called (otherwise, calling this function is a serious error).
 218  * Furthermore, if 'GNUNET_PEERINFO_add_peer' operations are still
 219  * pending, they will be cancelled silently on disconnect.
 220  *
 221  * @param h handle to disconnect
 222  */
 223 void
 224 GNUNET_PEERINFO_disconnect (struct GNUNET_PEERINFO_Handle *h)
 225 {
 226   struct GNUNET_PEERINFO_AddContext *ac;
 227   struct GNUNET_PEERINFO_IteratorContext *ic;
 228
 229   while (NULL != (ic = h->ic_head))
 230   {
 231     GNUNET_break (GNUNET_YES == ic->request_transmitted);
 232     ic->request_transmitted = GNUNET_NO;
 233     GNUNET_PEERINFO_iterate_cancel (ic);
 234   }
 235   while (NULL != (ac = h->ac_head))
 236   {
 237     GNUNET_CONTAINER_DLL_remove (h->ac_head, h->ac_tail, ac);
 238     if (NULL != ac->cont)
 239       ac->cont (ac->cont_cls, _("aborted due to explicit disconnect request"));
 240     GNUNET_free (ac);
 241   }
 242   if (NULL != h->th)
 243   {
 244     GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
 245     h->th = NULL;
 246   }
 247   if (NULL != h->client)
 248   {
 249     GNUNET_CLIENT_disconnect (h->client);
 250     h->client = NULL;
 251   }
 252   if (GNUNET_SCHEDULER_NO_TASK != h->r_task)
 253   {
 254     GNUNET_SCHEDULER_cancel (h->r_task);
 255     h->r_task = GNUNET_SCHEDULER_NO_TASK;
 256   }
 257   GNUNET_free (h);
 258 }
 259
 260
 261 /**
 262  * Check if we have a request pending in the transmission queue and are
 263  * able to transmit it right now.  If so, schedule transmission.
 264  *
 265  * @param h handle to the service
 266  */
 267 static void
 268 trigger_transmit (struct GNUNET_PEERINFO_Handle *h);
 269
 270
 271 /**
 272  * Close the existing connection to PEERINFO and reconnect.
 273  *
 274  * @param h handle to the service
 275  */
 276 static void
 277 reconnect (struct GNUNET_PEERINFO_Handle *h);
 278
 279
 280 /**
 281  * Task scheduled to re-try connecting to the peerinfo service.
 282  *
 283  * @param cls the 'struct GNUNET_PEERINFO_Handle'
 284  * @param tc scheduler context
 285  */
 286 static void
 287 reconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 288 {
 289   struct GNUNET_PEERINFO_Handle *h = cls;
 290
 291   h->r_task = GNUNET_SCHEDULER_NO_TASK;
 292   reconnect (h);
 293 }
 294
 295
 296 /**
 297  * Close the existing connection to PEERINFO and reconnect.
 298  *
 299  * @param h handle to the service
 300  */
 301 static void
 302 reconnect (struct GNUNET_PEERINFO_Handle *h)
 303 {
 304   if (GNUNET_SCHEDULER_NO_TASK != h->r_task)
 305   {
 306     GNUNET_SCHEDULER_cancel (h->r_task);
 307     h->r_task = GNUNET_SCHEDULER_NO_TASK;
 308   }
 309   if (NULL != h->th)
 310   {
 311     GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
 312     h->th = NULL;
 313   }
 314   if (NULL != h->client)
 315   {
 316     GNUNET_CLIENT_disconnect (h->client);
 317     h->client = NULL;
 318   }
 319   h->in_receive = GNUNET_NO;
 320   h->client = GNUNET_CLIENT_connect ("peerinfo", h->cfg);
 321   if (NULL == h->client)
 322   {
 323     h->r_task =
 324         GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &reconnect_task,
 325                                       h);
 326     return;
 327   }
 328   trigger_transmit (h);
 329 }
 330
 331
 332 /**
 333  * Transmit the request at the head of the transmission queue
 334  * and trigger continuation (if any).
 335  *
 336  * @param cls the 'struct GNUNET_PEERINFO_Handle' (with the queue)
 337  * @param size size of the buffer (0 on error)
 338  * @param buf where to copy the message
 339  * @return number of bytes copied to buf
 340  */
 341 static size_t
 342 do_transmit (void *cls, size_t size, void *buf)
 343 {
 344   struct GNUNET_PEERINFO_Handle *h = cls;
 345   struct GNUNET_PEERINFO_AddContext *ac = h->ac_head;
 346   size_t ret;
 347
 348   h->th = NULL;
 349   if (NULL == ac)
 350     return 0; /* request was cancelled in the meantime */
 351   if (NULL == buf)
 352   {
 353     /* peerinfo service died */
 354     LOG (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
 355          "Failed to transmit message to `%s' service.\n", "PEERINFO");
 356     GNUNET_CONTAINER_DLL_remove (h->ac_head, h->ac_tail, ac);
 357     reconnect (h);
 358     if (NULL != ac->cont)
 359       ac->cont (ac->cont_cls, _("failed to transmit request (service down?)"));
 360     GNUNET_free (ac);
 361     return 0;
 362   }
 363   ret = ac->size;
 364   if (size < ret)
 365   {
 366     /* change in head of queue (i.e. cancel + add), try again */
 367     trigger_transmit (h);
 368     return 0;
 369   }
 370   LOG (GNUNET_ERROR_TYPE_DEBUG,
 371        "Transmitting request of size %u to `%s' service.\n", ret, "PEERINFO");
 372   memcpy (buf, &ac[1], ret);
 373   GNUNET_CONTAINER_DLL_remove (h->ac_head, h->ac_tail, ac);
 374   trigger_transmit (h);
 375   if (NULL != ac->cont)
 376     ac->cont (ac->cont_cls, NULL);
 377   GNUNET_free (ac);
 378   return ret;
 379 }
 380
 381
 382 /**
 383  * Check if we have a request pending in the transmission queue and are
 384  * able to transmit it right now.  If so, schedule transmission.
 385  *
 386  * @param h handle to the service
 387  */
 388 static void
 389 trigger_transmit (struct GNUNET_PEERINFO_Handle *h)
 390 {
 391   struct GNUNET_PEERINFO_AddContext *ac;
 392
 393   if (NULL == (ac = h->ac_head))
 394     return; /* no requests queued */
 395   if (NULL != h->th)
 396     return; /* request already pending */
 397   if (GNUNET_YES == h->in_receive)
 398     return; /* still reading replies from last request */
 399   if (NULL == h->client)
 400   {
 401     /* disconnected, try to reconnect */
 402     reconnect (h);
 403     return;
 404   }
 405   h->th =
 406     GNUNET_CLIENT_notify_transmit_ready (h->client, ac->size,
 407                                          GNUNET_TIME_UNIT_FOREVER_REL,
 408                                          GNUNET_YES,
 409                                          &do_transmit, h);
 410 }
 411
 412
 413 /**
 414  * Add a host to the persistent list.  This method operates in
 415  * semi-reliable mode: if the transmission is not completed by
 416  * the time 'GNUNET_PEERINFO_disconnect' is called, it will be
 417  * aborted.  Furthermore, if a second HELLO is added for the
 418  * same peer before the first one was transmitted, PEERINFO may
 419  * merge the two HELLOs prior to transmission to the service.
 420  *
 421  * @param h handle to the peerinfo service
 422  * @param hello the verified (!) HELLO message
 423  * @param cont continuation to call when done, NULL is allowed
 424  * @param cont_cls closure for 'cont'
 425  * @return handle to cancel add operation; all pending
 426  *         'add' operations will be cancelled automatically
 427  *        on disconnect, so it is not necessary to keep this
 428  *        handle (unless 'cont' is NULL and at some point
 429  *        calling 'cont' must be prevented)
 430  */
 431 struct GNUNET_PEERINFO_AddContext *
 432 GNUNET_PEERINFO_add_peer (struct GNUNET_PEERINFO_Handle *h,
 433                           const struct GNUNET_HELLO_Message *hello,
 434                           GNUNET_PEERINFO_Continuation cont,
 435                           void *cont_cls)
 436 {
 437   uint16_t hs = GNUNET_HELLO_size (hello);
 438   struct GNUNET_PEERINFO_AddContext *ac;
 439   struct GNUNET_PeerIdentity peer;
 440
 441   GNUNET_assert (GNUNET_OK == GNUNET_HELLO_get_id (hello, &peer));
 442   LOG (GNUNET_ERROR_TYPE_DEBUG,
 443        "Adding peer `%s' to PEERINFO database (%u bytes of `%s')\n",
 444        GNUNET_i2s (&peer), hs, "HELLO");
 445   ac = GNUNET_malloc (sizeof (struct GNUNET_PEERINFO_AddContext) + hs);
 446   ac->h = h;
 447   ac->size = hs;
 448   ac->cont = cont;
 449   ac->cont_cls = cont_cls;
 450   memcpy (&ac[1], hello, hs);
 451   GNUNET_CONTAINER_DLL_insert_tail (h->ac_head, h->ac_tail, ac);
 452   trigger_transmit (h);
 453   return ac;
 454 }
 455
 456
 457 /**
 458  * Cancel pending 'add' operation.  Must only be called before
 459  * either 'cont' or 'GNUNET_PEERINFO_disconnect' are invoked.
 460  *
 461  * @param ac handle for the add operation to cancel
 462  */
 463 void
 464 GNUNET_PEERINFO_add_peer_cancel (struct GNUNET_PEERINFO_AddContext *ac)
 465 {
 466   struct GNUNET_PEERINFO_Handle *h = ac->h;
 467
 468   GNUNET_CONTAINER_DLL_remove (h->ac_head, h->ac_tail, ac);
 469   GNUNET_free (ac);
 470 }
 471
 472
 473 /**
 474  * Type of a function to call when we receive a message from the
 475  * service.  Call the iterator with the result and (if applicable)
 476  * continue to receive more messages or trigger processing the next
 477  * event (if applicable).
 478  *
 479  * @param cls closure
 480  * @param msg message received, NULL on timeout or fatal error
 481  */
 482 static void
 483 peerinfo_handler (void *cls, const struct GNUNET_MessageHeader *msg)
 484 {
 485   struct GNUNET_PEERINFO_Handle *h = cls;
 486   struct GNUNET_PEERINFO_IteratorContext *ic = h->ic_head;
 487   const struct InfoMessage *im;
 488   const struct GNUNET_HELLO_Message *hello;
 489   GNUNET_PEERINFO_Processor cb;
 490   struct GNUNET_PeerIdentity id;
 491   void *cb_cls;
 492   uint16_t ms;
 493
 494   GNUNET_assert (NULL != ic);
 495   h->in_receive = GNUNET_NO;
 496   ic->request_transmitted = GNUNET_NO;
 497   cb = ic->callback;
 498   cb_cls = ic->callback_cls;
 499   if (NULL == msg)
 500   {
 501     /* peerinfo service died, signal error */
 502     GNUNET_PEERINFO_iterate_cancel (ic);
 503     reconnect (h);
 504     if (NULL != cb)
 505       cb (cb_cls, NULL, NULL,
 506           _("Failed to receive response from `PEERINFO' service."));
 507     return;
 508   }
 509
 510   if (GNUNET_MESSAGE_TYPE_PEERINFO_INFO_END == ntohs (msg->type))
 511   {
 512     /* normal end of list of peers, signal end, process next pending request */
 513     LOG (GNUNET_ERROR_TYPE_DEBUG,
 514          "Received end of list of peers from `%s' service\n", "PEERINFO");
 515     GNUNET_PEERINFO_iterate_cancel (ic);
 516     trigger_transmit (h);
 517     if (GNUNET_NO == h->in_receive)
 518     {
 519       h->in_receive = GNUNET_YES;
 520       GNUNET_CLIENT_receive (h->client, &peerinfo_handler, h,
 521                              GNUNET_TIME_absolute_get_remaining (ic->timeout));
 522     }
 523     if (NULL != cb)
 524       cb (cb_cls, NULL, NULL, NULL);
 525     return;
 526   }
 527
 528   ms = ntohs (msg->size);
 529   if ((ms < sizeof (struct InfoMessage)) ||
 530       (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_PEERINFO_INFO))
 531   {
 532     /* malformed message */
 533     GNUNET_break (0);
 534     GNUNET_PEERINFO_iterate_cancel (ic);
 535     reconnect (h);
 536     if (NULL != cb)
 537       cb (cb_cls, NULL, NULL,
 538           _("Received invalid message from `PEERINFO' service."));
 539     return;
 540   }
 541   im = (const struct InfoMessage *) msg;
 542   GNUNET_break (0 == ntohl (im->reserved));
 543   if ( (GNUNET_YES == ic->have_peer) &&
 544        (0 != memcmp (&ic->peer, &im->peer, sizeof (struct GNUNET_PeerIdentity))) )
 545   {
 546     /* bogus message (from a different iteration call?); out of sequence! */
 547     LOG (GNUNET_ERROR_TYPE_ERROR,
 548          "Received HELLO for peer `%s', expected peer `%s'\n",
 549          GNUNET_h2s (&im->peer.hashPubKey),
 550          GNUNET_i2s (&ic->peer));
 551
 552     GNUNET_break (0);
 553     GNUNET_PEERINFO_iterate_cancel (ic);
 554     reconnect (h);
 555     if (NULL != cb)
 556       cb (cb_cls, NULL, NULL,
 557           _("Received invalid message from `PEERINFO' service."));
 558     return;
 559   }
 560   hello = NULL;
 561   if (ms > sizeof (struct InfoMessage) + sizeof (struct GNUNET_MessageHeader))
 562   {
 563     hello = (const struct GNUNET_HELLO_Message *) &im[1];
 564     if (ms != sizeof (struct InfoMessage) + GNUNET_HELLO_size (hello))
 565     {
 566       /* malformed message */
 567       GNUNET_break (0);
 568       GNUNET_PEERINFO_iterate_cancel (ic);
 569       reconnect (h);
 570       if (NULL != cb)
 571         cb (cb_cls, NULL, NULL,
 572             _("Received invalid message from `PEERINFO' service."));
 573       return;
 574     }
 575     if (GNUNET_OK != GNUNET_HELLO_get_id (hello, &id))
 576     {
 577       /* malformed message */
 578       GNUNET_break (0);
 579       GNUNET_PEERINFO_iterate_cancel (ic);
 580       reconnect (h);
 581       if (NULL != cb)
 582         cb (cb_cls, NULL, NULL,
 583             _("Received invalid message from `PEERINFO' service."));
 584       return;
 585     }
 586     if (0 != memcmp (&im->peer, &id, sizeof (struct GNUNET_PeerIdentity)))
 587     {
 588       /* malformed message */
 589       GNUNET_break (0);
 590       GNUNET_PEERINFO_iterate_cancel (ic);
 591       reconnect (h);
 592       if (NULL != cb)
 593         cb (cb_cls, NULL, NULL,
 594             _("Received invalid message from `PEERINFO' service."));
 595       return;
 596     }
 597   }
 598
 599   /* normal data message */
 600   LOG (GNUNET_ERROR_TYPE_DEBUG,
 601        "Received %u bytes of `%s' information about peer `%s' from `%s' service\n",
 602        (hello == NULL) ? 0 : (unsigned int) GNUNET_HELLO_size (hello), "HELLO",
 603        GNUNET_i2s (&im->peer), "PEERINFO");
 604   h->in_receive = GNUNET_YES;
 605   GNUNET_CLIENT_receive (h->client, &peerinfo_handler, h,
 606                          GNUNET_TIME_absolute_get_remaining (ic->timeout));
 607   if (NULL != cb)
 608     cb (cb_cls, &im->peer, hello, NULL);
 609 }
 610
 611
 612 /**
 613  * We've transmitted the iteration request.  Now get ready to process
 614  * the results (or handle transmission error).
 615  *
 616  * @param cls the 'struct GNUNET_PEERINFO_IteratorContext'
 617  * @param emsg error message, NULL if transmission worked
 618  */
 619 static void
 620 iterator_start_receive (void *cls, const char *emsg)
 621 {
 622   struct GNUNET_PEERINFO_IteratorContext *ic = cls;
 623   struct GNUNET_PEERINFO_Handle *h = ic->h;
 624   GNUNET_PEERINFO_Processor cb;
 625   void *cb_cls;
 626
 627   ic->ac = NULL;
 628   if (NULL != emsg)
 629   {
 630     cb = ic->callback;
 631     cb_cls = ic->callback_cls;
 632     GNUNET_PEERINFO_iterate_cancel (ic);
 633     reconnect (h);
 634     if (NULL != cb)
 635       cb (cb_cls, NULL, NULL, emsg);
 636     return;
 637   }
 638   LOG (GNUNET_ERROR_TYPE_DEBUG, "Waiting for response from `%s' service.\n",
 639        "PEERINFO");
 640   ic->request_transmitted = GNUNET_YES;
 641   if (GNUNET_NO == h->in_receive)
 642   {
 643     h->in_receive = GNUNET_YES;
 644     GNUNET_CLIENT_receive (h->client, &peerinfo_handler, h,
 645                            GNUNET_TIME_absolute_get_remaining (ic->timeout));
 646   }
 647 }
 648
 649
 650 /**
 651  * Peerinfo iteration request has timed out.
 652  *
 653  * @param cls the 'struct GNUNET_PEERINFO_IteratorContext*'
 654  * @param tc scheduler context
 655  */
 656 static void
 657 signal_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 658 {
 659   struct GNUNET_PEERINFO_IteratorContext *ic = cls;
 660   GNUNET_PEERINFO_Processor cb;
 661   void *cb_cls;
 662
 663   ic->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 664   cb = ic->callback;
 665   cb_cls = ic->callback_cls;
 666   GNUNET_PEERINFO_iterate_cancel (ic);
 667   if (NULL != cb)
 668     cb (cb_cls, NULL, NULL,
 669         _("Timeout transmitting iteration request to `PEERINFO' service."));
 670 }
 671
 672
 673 /**
 674  * Call a method for each known matching host and change its trust
 675  * value.  The callback method will be invoked once for each matching
 676  * host and then finally once with a NULL pointer.  After that final
 677  * invocation, the iterator context must no longer be used.
 678  *
 679  * Instead of calling this function with 'peer == NULL' it is often
 680  * better to use 'GNUNET_PEERINFO_notify'.
 681  *
 682  * @param h handle to the peerinfo service
 683  * @param peer restrict iteration to this peer only (can be NULL)
 684  * @param timeout how long to wait until timing out
 685  * @param callback the method to call for each peer
 686  * @param callback_cls closure for callback
 687  * @return iterator context
 688  */
 689 struct GNUNET_PEERINFO_IteratorContext *
 690 GNUNET_PEERINFO_iterate (struct GNUNET_PEERINFO_Handle *h,
 691                          const struct GNUNET_PeerIdentity *peer,
 692                          struct GNUNET_TIME_Relative timeout,
 693                          GNUNET_PEERINFO_Processor callback, void *callback_cls)
 694 {
 695   struct GNUNET_MessageHeader *lapm;
 696   struct ListPeerMessage *lpm;
 697   struct GNUNET_PEERINFO_IteratorContext *ic;
 698   struct GNUNET_PEERINFO_AddContext *ac;
 699
 700   ic = GNUNET_malloc (sizeof (struct GNUNET_PEERINFO_IteratorContext));
 701   if (NULL == peer)
 702   {
 703     LOG (GNUNET_ERROR_TYPE_DEBUG,
 704          "Requesting list of peers from PEERINFO service\n");
 705     ac =
 706         GNUNET_malloc (sizeof (struct GNUNET_PEERINFO_AddContext) +
 707                        sizeof (struct GNUNET_MessageHeader));
 708     ac->size = sizeof (struct GNUNET_MessageHeader);
 709     lapm = (struct GNUNET_MessageHeader *) &ac[1];
 710     lapm->size = htons (sizeof (struct GNUNET_MessageHeader));
 711     lapm->type = htons (GNUNET_MESSAGE_TYPE_PEERINFO_GET_ALL);
 712   }
 713   else
 714   {
 715     LOG (GNUNET_ERROR_TYPE_DEBUG,
 716          "Requesting information on peer `%4s' from PEERINFO service\n",
 717          GNUNET_i2s (peer));
 718     ac =
 719         GNUNET_malloc (sizeof (struct GNUNET_PEERINFO_AddContext) +
 720                        sizeof (struct ListPeerMessage));
 721     ac->size = sizeof (struct ListPeerMessage);
 722     lpm = (struct ListPeerMessage *) &ac[1];
 723     lpm->header.size = htons (sizeof (struct ListPeerMessage));
 724     lpm->header.type = htons (GNUNET_MESSAGE_TYPE_PEERINFO_GET);
 725     memcpy (&lpm->peer, peer, sizeof (struct GNUNET_PeerIdentity));
 726     ic->have_peer = GNUNET_YES;
 727     ic->peer = *peer;
 728   }
 729   ic->h = h;
 730   ic->ac = ac;
 731   ic->callback = callback;
 732   ic->callback_cls = callback_cls;
 733   ic->timeout = GNUNET_TIME_relative_to_absolute (timeout);
 734   ic->timeout_task =
 735       GNUNET_SCHEDULER_add_delayed (timeout, &signal_timeout, ic);
 736   ac->cont = &iterator_start_receive;
 737   ac->cont_cls = ic;
 738   GNUNET_CONTAINER_DLL_insert_tail (h->ac_head, h->ac_tail, ac);
 739   GNUNET_CONTAINER_DLL_insert_tail (h->ic_head,
 740                                     h->ic_tail,
 741                                     ic);
 742   trigger_transmit (h);
 743   return ic;
 744 }
 745
 746
 747 /**
 748  * Cancel an iteration over peer information.
 749  *
 750  * @param ic context of the iterator to cancel
 751  */
 752 void
 753 GNUNET_PEERINFO_iterate_cancel (struct GNUNET_PEERINFO_IteratorContext *ic)
 754 {
 755   struct GNUNET_PEERINFO_Handle *h;
 756
 757   h = ic->h;
 758   if (GNUNET_SCHEDULER_NO_TASK != ic->timeout_task)
 759   {
 760     GNUNET_SCHEDULER_cancel (ic->timeout_task);
 761     ic->timeout_task = GNUNET_SCHEDULER_NO_TASK;
 762   }
 763   ic->callback = NULL;
 764   if (GNUNET_YES == ic->request_transmitted)
 765     return;                     /* need to finish processing */
 766   GNUNET_CONTAINER_DLL_remove (h->ic_head,
 767                                h->ic_tail,
 768                                ic);
 769   if (NULL != ic->ac)
 770   {
 771     GNUNET_CONTAINER_DLL_remove (h->ac_head, h->ac_tail, ic->ac);
 772     GNUNET_free (ic->ac);
 773   }
 774   GNUNET_free (ic);
 775 }
 776
 777
 778 /* end of peerinfo_api.c */