src/set/set_api.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2012, 2013 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 set/set_api.c
  23  * @brief api for the set service
  24  * @author Florian Dold
  25  */
  26 #include "platform.h"
  27 #include "gnunet_util_lib.h"
  28 #include "gnunet_protocols.h"
  29 #include "gnunet_client_lib.h"
  30 #include "gnunet_set_service.h"
  31 #include "set.h"
  32
  33
  34 #define LOG(kind,...) GNUNET_log_from (kind, "set-api",__VA_ARGS__)
  35
  36 /**
  37  * Opaque handle to a set.
  38  */
  39 struct GNUNET_SET_Handle
  40 {
  41   /**
  42    * Client connected to the set service.
  43    */
  44   struct GNUNET_CLIENT_Connection *client;
  45
  46   /**
  47    * Message queue for 'client'.
  48    */
  49   struct GNUNET_MQ_Handle *mq;
  50
  51   /**
  52    * Linked list of operations on the set.
  53    */
  54   struct GNUNET_SET_OperationHandle *ops_head;
  55
  56   /**
  57    * Linked list of operations on the set.
  58    */
  59   struct GNUNET_SET_OperationHandle *ops_tail;
  60
  61   /**
  62    * Should the set be destroyed once all operations are gone?
  63    */
  64   int destroy_requested;
  65
  66   /**
  67    * Has the set become invalid (e.g. service died)?
  68    */
  69   int invalid;
  70
  71   /**
  72    * Callback for the current iteration over the set,
  73    * NULL if no iterator is active.
  74    */
  75   GNUNET_SET_ElementIterator iterator;
  76
  77   /**
  78    * Closure for 'iterator'
  79    */
  80   void *iterator_cls;
  81 };
  82
  83
  84 /**
  85  * Opaque handle to a set operation request from another peer.
  86  */
  87 struct GNUNET_SET_Request
  88 {
  89   /**
  90    * Id of the request, used to identify the request when
  91    * accepting/rejecting it.
  92    */
  93   uint32_t accept_id;
  94
  95   /**
  96    * Has the request been accepted already?
  97    * GNUNET_YES/GNUNET_NO
  98    */
  99   int accepted;
 100 };
 101
 102
 103 /**
 104  * Handle to an operation.
 105  * Only known to the service after commiting
 106  * the handle with a set.
 107  */
 108 struct GNUNET_SET_OperationHandle
 109 {
 110   /**
 111    * Function to be called when we have a result,
 112    * or an error.
 113    */
 114   GNUNET_SET_ResultIterator result_cb;
 115
 116   /**
 117    * Closure for result_cb.
 118    */
 119   void *result_cls;
 120
 121   /**
 122    * Local set used for the operation,
 123    * NULL if no set has been provided by conclude yet.
 124    */
 125   struct GNUNET_SET_Handle *set;
 126
 127   /**
 128    * Request ID to identify the operation within the set.
 129    */
 130   uint32_t request_id;
 131
 132   /**
 133    * Message sent to the server on calling conclude,
 134    * NULL if conclude has been called.
 135    */
 136   struct GNUNET_MQ_Envelope *conclude_mqm;
 137
 138   /**
 139    * Address of the request if in the conclude message,
 140    * used to patch the request id into the message when the set is known.
 141    */
 142   uint32_t *request_id_addr;
 143
 144   /**
 145    * Handles are kept in a linked list.
 146    */
 147   struct GNUNET_SET_OperationHandle *prev;
 148
 149   /**
 150    * Handles are kept in a linked list.
 151    */
 152   struct GNUNET_SET_OperationHandle *next;
 153 };
 154
 155
 156 /**
 157  * Opaque handle to a listen operation.
 158  */
 159 struct GNUNET_SET_ListenHandle
 160 {
 161   /**
 162    * Connection to the service.
 163    */
 164   struct GNUNET_CLIENT_Connection *client;
 165
 166   /**
 167    * Message queue for the client.
 168    */
 169   struct GNUNET_MQ_Handle* mq;
 170
 171   /**
 172    * Configuration handle for the listener, stored
 173    * here to be able to reconnect transparently on
 174    * connection failure.
 175    */
 176   const struct GNUNET_CONFIGURATION_Handle *cfg;
 177
 178   /**
 179    * Function to call on a new incoming request,
 180    * or on error.
 181    */
 182   GNUNET_SET_ListenCallback listen_cb;
 183
 184   /**
 185    * Closure for listen_cb.
 186    */
 187   void *listen_cls;
 188
 189   /**
 190    * Operation we listen for.
 191    */
 192   enum GNUNET_SET_OperationType operation;
 193
 194   /**
 195    * Application ID we listen for.
 196    */
 197   struct GNUNET_HashCode app_id;
 198
 199   /**
 200    * Time to wait until we try to reconnect on failure.
 201    */
 202   struct GNUNET_TIME_Relative reconnect_backoff;
 203
 204   /**
 205    * Task for reconnecting when the listener fails.
 206    */
 207   GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
 208 };
 209
 210
 211 /* forward declaration */
 212 static void
 213 listen_connect (void *cls,
 214                 const struct GNUNET_SCHEDULER_TaskContext *tc);
 215
 216
 217 /**
 218  * Handle element for iteration over the set.
 219  *
 220  * @param cls the set
 221  * @param mh the message
 222  */
 223 static void
 224 handle_iter_element (void *cls, const struct GNUNET_MessageHeader *mh)
 225 {
 226   struct GNUNET_SET_Handle *set = cls;
 227   struct GNUNET_SET_Element element;
 228   const struct GNUNET_SET_IterResponseMessage *msg =
 229     (const struct GNUNET_SET_IterResponseMessage *) mh;
 230   struct GNUNET_SET_IterAckMessage *ack_msg;
 231   struct GNUNET_MQ_Envelope *ev;
 232
 233   if (NULL == set->iterator)
 234     return;
 235
 236   element.size = ntohs (mh->size) - sizeof (struct GNUNET_SET_IterResponseMessage);
 237   element.type = htons (msg->element_type);
 238   element.data = &msg[1];
 239   set->iterator (set->iterator_cls, &element);
 240   ev = GNUNET_MQ_msg (ack_msg, GNUNET_MESSAGE_TYPE_SET_ITER_ACK);
 241   ack_msg->send_more = htonl (1);
 242   GNUNET_MQ_send (set->mq, ev);
 243 }
 244
 245
 246 /**
 247  * Handle element for iteration over the set.
 248  *
 249  * @param cls the set
 250  * @param mh the message
 251  */
 252 static void
 253 handle_iter_done (void *cls, const struct GNUNET_MessageHeader *mh)
 254 {
 255   struct GNUNET_SET_Handle *set = cls;
 256
 257   if (NULL == set->iterator)
 258     return;
 259
 260   set->iterator (set->iterator_cls, NULL);
 261 }
 262
 263
 264 /**
 265  * Handle result message for a set operation.
 266  *
 267  * @param cls the set
 268  * @param mh the message
 269  */
 270 static void
 271 handle_result (void *cls, const struct GNUNET_MessageHeader *mh)
 272 {
 273   const struct GNUNET_SET_ResultMessage *msg;
 274   struct GNUNET_SET_Handle *set = cls;
 275   struct GNUNET_SET_OperationHandle *oh;
 276   struct GNUNET_SET_Element e;
 277   enum GNUNET_SET_Status result_status;
 278
 279   msg = (const struct GNUNET_SET_ResultMessage *) mh;
 280   GNUNET_assert (NULL != set);
 281   GNUNET_assert (NULL != set->mq);
 282
 283   result_status = ntohs (msg->result_status);
 284
 285   oh = GNUNET_MQ_assoc_get (set->mq, ntohl (msg->request_id));
 286   // 'oh' can be NULL if we canceled the operation, but the service
 287   // did not get the cancel message yet.
 288   if (NULL == oh)
 289   {
 290     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ignoring result from canceled operation\n");
 291     return;
 292   }
 293   /* status is not STATUS_OK => there's no attached element,
 294    * and this is the last result message we get */
 295   if (GNUNET_SET_STATUS_OK != result_status)
 296   {
 297     GNUNET_MQ_assoc_remove (set->mq, ntohl (msg->request_id));
 298     GNUNET_CONTAINER_DLL_remove (oh->set->ops_head, oh->set->ops_tail, oh);
 299     if (GNUNET_YES == oh->set->destroy_requested)
 300       GNUNET_SET_destroy (oh->set);
 301     if (NULL != oh->result_cb)
 302       oh->result_cb (oh->result_cls, NULL, result_status);
 303     GNUNET_free (oh);
 304     return;
 305   }
 306
 307   e.data = &msg[1];
 308   e.size = ntohs (mh->size) - sizeof (struct GNUNET_SET_ResultMessage);
 309   e.type = msg->element_type;
 310   if (NULL != oh->result_cb)
 311     oh->result_cb (oh->result_cls, &e, result_status);
 312 }
 313
 314
 315 /**
 316  * Handle request message for a listen operation
 317  *
 318  * @param cls the listen handle
 319  * @param mh the message
 320  */
 321 static void
 322 handle_request (void *cls,
 323                 const struct GNUNET_MessageHeader *mh)
 324 {
 325   const struct GNUNET_SET_RequestMessage *msg = (const struct GNUNET_SET_RequestMessage *) mh;
 326   struct GNUNET_SET_ListenHandle *lh = cls;
 327   struct GNUNET_SET_Request *req;
 328   struct GNUNET_MessageHeader *context_msg;
 329
 330   LOG (GNUNET_ERROR_TYPE_DEBUG,
 331        "processing operation request\n");
 332   req = GNUNET_new (struct GNUNET_SET_Request);
 333   req->accept_id = ntohl (msg->accept_id);
 334   context_msg = GNUNET_MQ_extract_nested_mh (msg);
 335   /* calling GNUNET_SET_accept in the listen cb will set req->accepted */
 336   lh->listen_cb (lh->listen_cls, &msg->peer_id, context_msg, req);
 337
 338   /* we got another request => reset the backoff */
 339   lh->reconnect_backoff = GNUNET_TIME_UNIT_MILLISECONDS;
 340
 341   if (GNUNET_NO == req->accepted)
 342   {
 343     struct GNUNET_MQ_Envelope *mqm;
 344     struct GNUNET_SET_RejectMessage *rmsg;
 345
 346     mqm = GNUNET_MQ_msg (rmsg,
 347                          GNUNET_MESSAGE_TYPE_SET_REJECT);
 348     /* no request id, as we refused */
 349     rmsg->request_id = htonl (0);
 350     rmsg->accept_reject_id = msg->accept_id;
 351     GNUNET_MQ_send (lh->mq, mqm);
 352     LOG (GNUNET_ERROR_TYPE_DEBUG,
 353          "rejecting request\n");
 354   }
 355   GNUNET_free (req);
 356
 357   LOG (GNUNET_ERROR_TYPE_DEBUG,
 358        "processed op request from service\n");
 359
 360   /* the accept-case is handled in GNUNET_SET_accept,
 361    * as we have the accept message available there */
 362 }
 363
 364
 365 static void
 366 handle_client_listener_error (void *cls, enum GNUNET_MQ_Error error)
 367 {
 368   struct GNUNET_SET_ListenHandle *lh = cls;
 369
 370   LOG (GNUNET_ERROR_TYPE_DEBUG,
 371        "listener broke down, re-connecting\n");
 372   GNUNET_CLIENT_disconnect (lh->client);
 373   lh->client = NULL;
 374   GNUNET_MQ_destroy (lh->mq);
 375   lh->mq = NULL;
 376   lh->reconnect_task = GNUNET_SCHEDULER_add_delayed (lh->reconnect_backoff,
 377                                                      &listen_connect, lh);
 378   lh->reconnect_backoff = GNUNET_TIME_STD_BACKOFF (lh->reconnect_backoff);
 379 }
 380
 381
 382 /**
 383  * Destroy the set handle if no operations are left, mark the set
 384  * for destruction otherwise.
 385  *
 386  * @param set set handle to destroy
 387  */
 388 static int
 389 set_destroy (struct GNUNET_SET_Handle *set)
 390 {
 391   if (NULL != set->ops_head)
 392   {
 393     set->destroy_requested = GNUNET_YES;
 394     return GNUNET_NO;
 395   }
 396   LOG (GNUNET_ERROR_TYPE_DEBUG, "Really destroying set\n");
 397   GNUNET_CLIENT_disconnect (set->client);
 398   set->client = NULL;
 399   GNUNET_MQ_destroy (set->mq);
 400   set->mq = NULL;
 401   GNUNET_free (set);
 402   return GNUNET_YES;
 403 }
 404
 405
 406
 407
 408 /**
 409  * Cancel the given set operation.  We need to send an explicit cancel message,
 410  * as all operations one one set communicate using one handle.
 411  *
 412  * In contrast to GNUNET_SET_operation_cancel, this function indicates whether
 413  * the set of the operation has been destroyed because all operations are done and
 414  * the set's destruction was requested before.
 415  *
 416  * @param oh set operation to cancel
 417  * @return GNUNET_YES if the set of the operation was destroyed
 418  */
 419 static int
 420 set_operation_cancel (struct GNUNET_SET_OperationHandle *oh)
 421 {
 422   int ret = GNUNET_NO;
 423
 424   if (NULL != oh->conclude_mqm)
 425     GNUNET_MQ_discard (oh->conclude_mqm);
 426
 427   /* is the operation already commited? */
 428   if (NULL != oh->set)
 429   {
 430     struct GNUNET_SET_OperationHandle *h_assoc;
 431     struct GNUNET_SET_CancelMessage *m;
 432     struct GNUNET_MQ_Envelope *mqm;
 433
 434     GNUNET_CONTAINER_DLL_remove (oh->set->ops_head, oh->set->ops_tail, oh);
 435     h_assoc = GNUNET_MQ_assoc_remove (oh->set->mq, oh->request_id);
 436     GNUNET_assert ((h_assoc == NULL) || (h_assoc == oh));
 437     mqm = GNUNET_MQ_msg (m, GNUNET_MESSAGE_TYPE_SET_CANCEL);
 438     m->request_id = htonl (oh->request_id);
 439     GNUNET_MQ_send (oh->set->mq, mqm);
 440
 441     if (GNUNET_YES == oh->set->destroy_requested)
 442     {
 443       LOG (GNUNET_ERROR_TYPE_DEBUG, "destroying set after operation cancel\n");
 444       ret = set_destroy (oh->set);
 445     }
 446   }
 447
 448   GNUNET_free (oh);
 449
 450   return ret;
 451 }
 452
 453
 454 /**
 455  * Cancel the given set operation.  We need to send an explicit cancel message,
 456  * as all operations one one set communicate using one handle.
 457  *
 458  * @param oh set operation to cancel
 459  */
 460 void
 461 GNUNET_SET_operation_cancel (struct GNUNET_SET_OperationHandle *oh)
 462 {
 463   (void) set_operation_cancel (oh);
 464 }
 465
 466
 467 static void
 468 handle_client_set_error (void *cls, enum GNUNET_MQ_Error error)
 469 {
 470   struct GNUNET_SET_Handle *set = cls;
 471
 472   LOG (GNUNET_ERROR_TYPE_DEBUG, "handling client set error\n");
 473
 474   while (NULL != set->ops_head)
 475   {
 476     if (NULL != set->ops_head->result_cb)
 477       set->ops_head->result_cb (set->ops_head->result_cls, NULL,
 478                                 GNUNET_SET_STATUS_FAILURE);
 479     if (GNUNET_YES == set_operation_cancel (set->ops_head))
 480       return; /* stop if the set is destroyed */
 481   }
 482   set->invalid = GNUNET_YES;
 483 }
 484
 485
 486 /**
 487  * Create an empty set, supporting the specified operation.
 488  *
 489  * @param cfg configuration to use for connecting to the
 490  *        set service
 491  * @param op operation supported by the set
 492  *        Note that the operation has to be specified
 493  *        beforehand, as certain set operations need to maintain
 494  *        data structures spefific to the operation
 495  * @return a handle to the set
 496  */
 497 struct GNUNET_SET_Handle *
 498 GNUNET_SET_create (const struct GNUNET_CONFIGURATION_Handle *cfg,
 499                    enum GNUNET_SET_OperationType op)
 500 {
 501   static const struct GNUNET_MQ_MessageHandler mq_handlers[] = {
 502     {handle_result, GNUNET_MESSAGE_TYPE_SET_RESULT, 0},
 503     {handle_iter_element, GNUNET_MESSAGE_TYPE_SET_ITER_ELEMENT, 0},
 504     {handle_iter_done, GNUNET_MESSAGE_TYPE_SET_ITER_DONE, 0},
 505     GNUNET_MQ_HANDLERS_END
 506   };
 507   struct GNUNET_SET_Handle *set;
 508   struct GNUNET_MQ_Envelope *mqm;
 509   struct GNUNET_SET_CreateMessage *msg;
 510
 511   set = GNUNET_new (struct GNUNET_SET_Handle);
 512   set->client = GNUNET_CLIENT_connect ("set", cfg);
 513   LOG (GNUNET_ERROR_TYPE_DEBUG, "set client created\n");
 514   GNUNET_assert (NULL != set->client);
 515   set->mq = GNUNET_MQ_queue_for_connection_client (set->client, mq_handlers,
 516                                                    handle_client_set_error, set);
 517   GNUNET_assert (NULL != set->mq);
 518   mqm = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_SET_CREATE);
 519   msg->operation = htonl (op);
 520   GNUNET_MQ_send (set->mq, mqm);
 521   return set;
 522 }
 523
 524
 525 /**
 526  * Add an element to the given set.
 527  * After the element has been added (in the sense of being
 528  * transmitted to the set service), cont will be called.
 529  * Calls to add_element can be queued
 530  *
 531  * @param set set to add element to
 532  * @param element element to add to the set
 533  * @param cont continuation called after the element has been added
 534  * @param cont_cls closure for @a cont
 535  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the
 536  *         set is invalid (e.g. the set service crashed)
 537  */
 538 int
 539 GNUNET_SET_add_element (struct GNUNET_SET_Handle *set,
 540                         const struct GNUNET_SET_Element *element,
 541                         GNUNET_SET_Continuation cont,
 542                         void *cont_cls)
 543 {
 544   struct GNUNET_MQ_Envelope *mqm;
 545   struct GNUNET_SET_ElementMessage *msg;
 546
 547   if (GNUNET_YES == set->invalid)
 548   {
 549     if (NULL != cont)
 550       cont (cont_cls);
 551     return GNUNET_SYSERR;
 552   }
 553
 554   mqm = GNUNET_MQ_msg_extra (msg, element->size, GNUNET_MESSAGE_TYPE_SET_ADD);
 555   msg->element_type = element->type;
 556   memcpy (&msg[1], element->data, element->size);
 557   GNUNET_MQ_notify_sent (mqm, cont, cont_cls);
 558   GNUNET_MQ_send (set->mq, mqm);
 559   return GNUNET_OK;
 560 }
 561
 562
 563 /**
 564  * Remove an element to the given set.
 565  * After the element has been removed (in the sense of the
 566  * request being transmitted to the set service), cont will be called.
 567  * Calls to remove_element can be queued
 568  *
 569  * @param set set to remove element from
 570  * @param element element to remove from the set
 571  * @param cont continuation called after the element has been removed
 572  * @param cont_cls closure for cont
 573  * @return GNUNET_OK on success, GNUNET_SYSERR if the
 574  *         set is invalid (e.g. the set service crashed)
 575  */
 576 int
 577 GNUNET_SET_remove_element (struct GNUNET_SET_Handle *set,
 578                            const struct GNUNET_SET_Element *element,
 579                            GNUNET_SET_Continuation cont,
 580                            void *cont_cls)
 581 {
 582   struct GNUNET_MQ_Envelope *mqm;
 583   struct GNUNET_SET_ElementMessage *msg;
 584
 585   if (GNUNET_YES == set->invalid)
 586   {
 587     if (NULL != cont)
 588       cont (cont_cls);
 589     return GNUNET_SYSERR;
 590   }
 591
 592   mqm = GNUNET_MQ_msg_extra (msg, element->size, GNUNET_MESSAGE_TYPE_SET_REMOVE);
 593   msg->element_type = element->type;
 594   memcpy (&msg[1], element->data, element->size);
 595   GNUNET_MQ_notify_sent (mqm, cont, cont_cls);
 596   GNUNET_MQ_send (set->mq, mqm);
 597   return GNUNET_OK;
 598 }
 599
 600
 601 /**
 602  * Destroy the set handle, and free all associated resources.
 603  *
 604  * @param set set handle to destroy
 605  */
 606 void
 607 GNUNET_SET_destroy (struct GNUNET_SET_Handle *set)
 608 {
 609   (void) set_destroy (set);
 610 }
 611
 612
 613 /**
 614  * Prepare a set operation to be evaluated with another peer.
 615  * The evaluation will not start until the client provides
 616  * a local set with #GNUNET_SET_commit().
 617  *
 618  * @param other_peer peer with the other set
 619  * @param app_id hash for the application using the set
 620  * @param context_msg additional information for the request
 621  * @param result_mode specified how results will be returned,
 622  *        see `enum GNUNET_SET_ResultMode`.
 623  * @param result_cb called on error or success
 624  * @param result_cls closure for @e result_cb
 625  * @return a handle to cancel the operation
 626  */
 627 struct GNUNET_SET_OperationHandle *
 628 GNUNET_SET_prepare (const struct GNUNET_PeerIdentity *other_peer,
 629                     const struct GNUNET_HashCode *app_id,
 630                     const struct GNUNET_MessageHeader *context_msg,
 631                     enum GNUNET_SET_ResultMode result_mode,
 632                     GNUNET_SET_ResultIterator result_cb,
 633                     void *result_cls)
 634 {
 635   struct GNUNET_MQ_Envelope *mqm;
 636   struct GNUNET_SET_OperationHandle *oh;
 637   struct GNUNET_SET_EvaluateMessage *msg;
 638
 639   oh = GNUNET_new (struct GNUNET_SET_OperationHandle);
 640   oh->result_cb = result_cb;
 641   oh->result_cls = result_cls;
 642
 643   mqm = GNUNET_MQ_msg_nested_mh (msg,
 644                                  GNUNET_MESSAGE_TYPE_SET_EVALUATE,
 645                                  context_msg);
 646   msg->app_id = *app_id;
 647   msg->result_mode = htonl (result_mode);
 648   msg->target_peer = *other_peer;
 649   oh->conclude_mqm = mqm;
 650   oh->request_id_addr = &msg->request_id;
 651
 652   return oh;
 653 }
 654
 655
 656 /**
 657  * Connect to the set service in order to listen
 658  * for request.
 659  *
 660  * @param cls the listen handle to connect
 661  * @param tc task context if invoked as a task, NULL otherwise
 662  */
 663 static void
 664 listen_connect (void *cls,
 665                 const struct GNUNET_SCHEDULER_TaskContext *tc)
 666 {
 667   struct GNUNET_MQ_Envelope *mqm;
 668   struct GNUNET_SET_ListenMessage *msg;
 669   struct GNUNET_SET_ListenHandle *lh = cls;
 670   static const struct GNUNET_MQ_MessageHandler mq_handlers[] = {
 671     {handle_request, GNUNET_MESSAGE_TYPE_SET_REQUEST},
 672     GNUNET_MQ_HANDLERS_END
 673   };
 674
 675   if ((tc != NULL) &&(tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
 676   {
 677     LOG (GNUNET_ERROR_TYPE_DEBUG, "listener not reconnecting due to shutdown\n");
 678     return;
 679   }
 680
 681   lh->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
 682
 683   GNUNET_assert (NULL == lh->client);
 684   lh->client = GNUNET_CLIENT_connect ("set", lh->cfg);
 685   if (NULL == lh->client)
 686   {
 687     LOG (GNUNET_ERROR_TYPE_ERROR,
 688          "could not connect to set (wrong configuration?), giving up listening\n");
 689     return;
 690   }
 691   GNUNET_assert (NULL == lh->mq);
 692   lh->mq = GNUNET_MQ_queue_for_connection_client (lh->client, mq_handlers,
 693                                                   handle_client_listener_error, lh);
 694   mqm = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_SET_LISTEN);
 695   msg->operation = htonl (lh->operation);
 696   msg->app_id = lh->app_id;
 697   GNUNET_MQ_send (lh->mq, mqm);
 698 }
 699
 700
 701 /**
 702  * Wait for set operation requests for the given application id
 703  *
 704  * @param cfg configuration to use for connecting to
 705  *            the set service, needs to be valid for the lifetime of the listen handle
 706  * @param operation operation we want to listen for
 707  * @param app_id id of the application that handles set operation requests
 708  * @param listen_cb called for each incoming request matching the operation
 709  *                  and application id
 710  * @param listen_cls handle for listen_cb
 711  * @return a handle that can be used to cancel the listen operation
 712  */
 713 struct GNUNET_SET_ListenHandle *
 714 GNUNET_SET_listen (const struct GNUNET_CONFIGURATION_Handle *cfg,
 715                    enum GNUNET_SET_OperationType operation,
 716                    const struct GNUNET_HashCode *app_id,
 717                    GNUNET_SET_ListenCallback listen_cb,
 718                    void *listen_cls)
 719 {
 720   struct GNUNET_SET_ListenHandle *lh;
 721
 722   lh = GNUNET_new (struct GNUNET_SET_ListenHandle);
 723   lh->listen_cb = listen_cb;
 724   lh->listen_cls = listen_cls;
 725   lh->cfg = cfg;
 726   lh->operation = operation;
 727   lh->app_id = *app_id;
 728   lh->reconnect_backoff = GNUNET_TIME_UNIT_MILLISECONDS;
 729   listen_connect (lh, NULL);
 730   return lh;
 731 }
 732
 733
 734 /**
 735  * Cancel the given listen operation.
 736  *
 737  * @param lh handle for the listen operation
 738  */
 739 void
 740 GNUNET_SET_listen_cancel (struct GNUNET_SET_ListenHandle *lh)
 741 {
 742   LOG (GNUNET_ERROR_TYPE_DEBUG, "canceling listener\n");
 743   /* listener's connection may have failed, thus mq/client could be NULL */
 744   if (NULL != lh->mq)
 745   {
 746     GNUNET_MQ_destroy (lh->mq);
 747     lh->mq = NULL;
 748   }
 749   if (NULL != lh->client)
 750   {
 751     GNUNET_CLIENT_disconnect (lh->client);
 752     lh->client = NULL;
 753   }
 754   if (GNUNET_SCHEDULER_NO_TASK != lh->reconnect_task)
 755   {
 756     GNUNET_SCHEDULER_cancel (lh->reconnect_task);
 757     lh->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
 758   }
 759   GNUNET_free (lh);
 760 }
 761
 762
 763 /**
 764  * Accept a request we got via #GNUNET_SET_listen.  Must be called during
 765  * #GNUNET_SET_listen, as the 'struct GNUNET_SET_Request' becomes invalid
 766  * afterwards.
 767  * Call #GNUNET_SET_commit to provide the local set to use for the operation,
 768  * and to begin the exchange with the remote peer.
 769  *
 770  * @param request request to accept
 771  * @param result_mode specified how results will be returned,
 772  *        see `enum GNUNET_SET_ResultMode`.
 773  * @param result_cb callback for the results
 774  * @param result_cls closure for @a result_cb
 775  * @return a handle to cancel the operation
 776  */
 777 struct GNUNET_SET_OperationHandle *
 778 GNUNET_SET_accept (struct GNUNET_SET_Request *request,
 779                    enum GNUNET_SET_ResultMode result_mode,
 780                    GNUNET_SET_ResultIterator result_cb,
 781                    void *result_cls)
 782 {
 783   struct GNUNET_MQ_Envelope *mqm;
 784   struct GNUNET_SET_OperationHandle *oh;
 785   struct GNUNET_SET_AcceptMessage *msg;
 786
 787   GNUNET_assert (NULL != request);
 788   GNUNET_assert (GNUNET_NO == request->accepted);
 789   request->accepted = GNUNET_YES;
 790
 791   oh = GNUNET_new (struct GNUNET_SET_OperationHandle);
 792   oh->result_cb = result_cb;
 793   oh->result_cls = result_cls;
 794
 795   mqm = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_SET_ACCEPT);
 796   msg->accept_reject_id = htonl (request->accept_id);
 797   msg->result_mode = htonl (result_mode);
 798
 799   oh->conclude_mqm = mqm;
 800   oh->request_id_addr = &msg->request_id;
 801
 802   return oh;
 803 }
 804
 805
 806 /**
 807  * Commit a set to be used with a set operation.
 808  * This function is called once we have fully constructed
 809  * the set that we want to use for the operation.  At this
 810  * time, the P2P protocol can then begin to exchange the
 811  * set information and call the result callback with the
 812  * result information.
 813  *
 814  * @param oh handle to the set operation
 815  * @param set the set to use for the operation
 816  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the
 817  *         set is invalid (e.g. the set service crashed)
 818  */
 819 int
 820 GNUNET_SET_commit (struct GNUNET_SET_OperationHandle *oh,
 821                    struct GNUNET_SET_Handle *set)
 822 {
 823   GNUNET_assert (NULL == oh->set);
 824   if (GNUNET_YES == set->invalid)
 825     return GNUNET_SYSERR;
 826   GNUNET_assert (NULL != oh->conclude_mqm);
 827   oh->set = set;
 828   GNUNET_CONTAINER_DLL_insert (set->ops_head, set->ops_tail, oh);
 829   oh->request_id = GNUNET_MQ_assoc_add (set->mq, oh);
 830   *oh->request_id_addr = htonl (oh->request_id);
 831   GNUNET_MQ_send (set->mq, oh->conclude_mqm);
 832   oh->conclude_mqm = NULL;
 833   oh->request_id_addr = NULL;
 834   return GNUNET_OK;
 835 }
 836
 837
 838 /**
 839  * Iterate over all elements in the given set.
 840  * Note that this operation involves transferring every element of the set
 841  * from the service to the client, and is thus costly.
 842  *
 843  * @param set the set to iterate over
 844  * @param iter the iterator to call for each element
 845  * @param cls closure for @a iter
 846  * @return #GNUNET_YES if the iteration started successfuly,
 847  *         #GNUNET_NO if another iteration is active
 848  *         #GNUNET_SYSERR if the set is invalid (e.g. the server crashed, disconnected)
 849  */
 850 int
 851 GNUNET_SET_iterate (struct GNUNET_SET_Handle *set, GNUNET_SET_ElementIterator iter, void *cls)
 852 {
 853   struct GNUNET_MQ_Envelope *ev;
 854
 855
 856   GNUNET_assert (NULL != iter);
 857
 858   if (GNUNET_YES == set->invalid)
 859     return GNUNET_SYSERR;
 860   if (NULL != set->iterator)
 861     return GNUNET_NO;
 862
 863   LOG (GNUNET_ERROR_TYPE_DEBUG, "iterating set\n");
 864
 865   set->iterator = iter;
 866   set->iterator_cls = cls;
 867   ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_SET_ITER_REQUEST);
 868   GNUNET_MQ_send (set->mq, ev);
 869   return GNUNET_YES;
 870 }
 871
 872 /* end of set_api.c */