src/include/gnunet_set_service.h

   1 /*
   2       This file is part of GNUnet
   3       Copyright (C) 2013, 2014 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 include/gnunet_set_service.h
  23  * @brief two-peer set operations
  24  * @author Florian Dold
  25  * @author Christian Grothoff
  26  */
  27
  28 #ifndef GNUNET_SET_SERVICE_H
  29 #define GNUNET_SET_SERVICE_H
  30
  31 #ifdef __cplusplus
  32 extern "C"
  33 {
  34 #if 0                           /* keep Emacsens' auto-indent happy */
  35 }
  36 #endif
  37 #endif
  38
  39 #include "gnunet_common.h"
  40 #include "gnunet_time_lib.h"
  41 #include "gnunet_configuration_lib.h"
  42
  43
  44 /**
  45  * Maximum size of a context message for set operation requests.
  46  */
  47 #define GNUNET_SET_CONTEXT_MESSAGE_MAX_SIZE ((1<<16) - 1024)
  48
  49
  50 /**
  51  * Opaque handle to a set.
  52  */
  53 struct GNUNET_SET_Handle;
  54
  55 /**
  56  * Opaque handle to a set operation request from another peer.
  57  */
  58 struct GNUNET_SET_Request;
  59
  60 /**
  61  * Opaque handle to a listen operation.
  62  */
  63 struct GNUNET_SET_ListenHandle;
  64
  65 /**
  66  * Opaque handle to a set operation.
  67  */
  68 struct GNUNET_SET_OperationHandle;
  69
  70
  71 /**
  72  * The operation that a set set supports.
  73  */
  74 enum GNUNET_SET_OperationType
  75 {
  76   /**
  77    * A purely local set that does not support any operation.
  78    */
  79   GNUNET_SET_OPERATION_NONE,
  80
  81   /**
  82    * Set intersection, only return elements that are in both sets.
  83    */
  84   GNUNET_SET_OPERATION_INTERSECTION,
  85
  86   /**
  87    * Set union, return all elements that are in at least one of the sets.
  88    */
  89   GNUNET_SET_OPERATION_UNION
  90 };
  91
  92
  93 /**
  94  * Status for the result callback
  95  */
  96 enum GNUNET_SET_Status
  97 {
  98   /**
  99    * Everything went ok, we are transmitting an element of the
 100    * result (in set, or to be removed from set, depending on
 101    * the `enum GNUNET_SET_ResultMode`).
 102    */
 103   GNUNET_SET_STATUS_OK,
 104
 105   /**
 106    * The other peer refused to to the operation with us,
 107    * or something went wrong.
 108    */
 109   GNUNET_SET_STATUS_FAILURE,
 110
 111   /**
 112    * Success, all elements have been returned (but the other peer
 113    * might still be receiving some from us, so we are not done).  Only
 114    * used during UNION operation.
 115    */
 116   GNUNET_SET_STATUS_HALF_DONE,
 117
 118   /**
 119    * Success, all elements have been sent (and received).
 120    */
 121   GNUNET_SET_STATUS_DONE
 122 };
 123
 124
 125 /**
 126  * The way results are given to the client.
 127  */
 128 enum GNUNET_SET_ResultMode
 129 {
 130   /**
 131    * Client gets every element in the resulting set.
 132    */
 133   GNUNET_SET_RESULT_FULL,
 134
 135   /**
 136    * Client gets only elements that have been added to the set.
 137    * Only works with set union.
 138    */
 139   GNUNET_SET_RESULT_ADDED,
 140
 141   /**
 142    * Client gets only elements that have been removed from the set.
 143    * Only works with set intersection.
 144    */
 145   GNUNET_SET_RESULT_REMOVED
 146 };
 147
 148
 149 /**
 150  * Element stored in a set.
 151  */
 152 struct GNUNET_SET_Element
 153 {
 154   /**
 155    * Number of bytes in the buffer pointed to by data.
 156    */
 157   uint16_t size;
 158
 159   /**
 160    * Application-specific element type.
 161    */
 162   uint16_t element_type;
 163
 164   /**
 165    * Actual data of the element
 166    */
 167   const void *data;
 168 };
 169
 170
 171 /**
 172  * Continuation used for some of the set operations
 173  *
 174  * @param cls closure
 175  */
 176 typedef void (*GNUNET_SET_Continuation) (void *cls);
 177
 178
 179 /**
 180  * Callback for set operation results. Called for each element
 181  * in the result set.
 182  *
 183  * @param cls closure
 184  * @param element a result element, only valid if status is #GNUNET_SET_STATUS_OK
 185  * @param status see `enum GNUNET_SET_Status`
 186  */
 187 typedef void (*GNUNET_SET_ResultIterator) (void *cls,
 188                                            const struct GNUNET_SET_Element *element,
 189                                            enum GNUNET_SET_Status status);
 190
 191 /**
 192  * Iterator for set elements.
 193  *
 194  * @param cls closure
 195  * @param element the current element, NULL if all elements have been
 196  *        iterated over
 197  * @return #GNUNET_YES to continue iterating, #GNUNET_NO to stop.
 198  */
 199 typedef int (*GNUNET_SET_ElementIterator) (void *cls,
 200                                            const struct GNUNET_SET_Element *element);
 201
 202
 203 /**
 204  * Called when another peer wants to do a set operation with the
 205  * local peer. If a listen error occurs, the @a request is NULL.
 206  *
 207  * @param cls closure
 208  * @param other_peer the other peer
 209  * @param context_msg message with application specific information from
 210  *        the other peer
 211  * @param request request from the other peer (never NULL), use GNUNET_SET_accept()
 212  *        to accept it, otherwise the request will be refused
 213  *        Note that we can't just return value from the listen callback,
 214  *        as it is also necessary to specify the set we want to do the
 215  *        operation with, whith sometimes can be derived from the context
 216  *        message. It's necessary to specify the timeout.
 217  */
 218 typedef void
 219 (*GNUNET_SET_ListenCallback) (void *cls,
 220                               const struct GNUNET_PeerIdentity *other_peer,
 221                               const struct GNUNET_MessageHeader *context_msg,
 222                               struct GNUNET_SET_Request *request);
 223
 224
 225
 226 /**
 227  * Create an empty set, supporting the specified operation.
 228  *
 229  * @param cfg configuration to use for connecting to the
 230  *        set service
 231  * @param op operation supported by the set
 232  *        Note that the operation has to be specified
 233  *        beforehand, as certain set operations need to maintain
 234  *        data structures spefific to the operation
 235  * @return a handle to the set
 236  */
 237 struct GNUNET_SET_Handle *
 238 GNUNET_SET_create (const struct GNUNET_CONFIGURATION_Handle *cfg,
 239                    enum GNUNET_SET_OperationType op);
 240
 241
 242 /**
 243  * Add an element to the given set.
 244  * After the element has been added (in the sense of being
 245  * transmitted to the set service), @a cont will be called.
 246  * Calls to #GNUNET_SET_add_element can be queued
 247  *
 248  * @param set set to add element to
 249  * @param element element to add to the set
 250  * @param cont continuation called after the element has been added
 251  * @param cont_cls closure for @a cont
 252  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the
 253  *         set is invalid (e.g. the set service crashed)
 254  */
 255 int
 256 GNUNET_SET_add_element (struct GNUNET_SET_Handle *set,
 257                         const struct GNUNET_SET_Element *element,
 258                         GNUNET_SET_Continuation cont,
 259                         void *cont_cls);
 260
 261
 262 /**
 263  * Remove an element to the given set.
 264  * After the element has been removed (in the sense of the
 265  * request being transmitted to the set service), cont will be called.
 266  * Calls to remove_element can be queued
 267  *
 268  * @param set set to remove element from
 269  * @param element element to remove from the set
 270  * @param cont continuation called after the element has been removed
 271  * @param cont_cls closure for @a cont
 272  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the
 273  *         set is invalid (e.g. the set service crashed)
 274  */
 275 int
 276 GNUNET_SET_remove_element (struct GNUNET_SET_Handle *set,
 277                            const struct GNUNET_SET_Element *element,
 278                            GNUNET_SET_Continuation cont,
 279                            void *cont_cls);
 280
 281
 282 /**
 283  * Destroy the set handle, and free all associated resources.
 284  * Iterations must have completed (or be explicitly canceled)
 285  * before destroying the corresponding set.  Operations may
 286  * still be pending when a set is destroyed.
 287  *
 288  * @param set set to destroy
 289  */
 290 void
 291 GNUNET_SET_destroy (struct GNUNET_SET_Handle *set);
 292
 293
 294 /**
 295  * Prepare a set operation to be evaluated with another peer.
 296  * The evaluation will not start until the client provides
 297  * a local set with GNUNET_SET_commit().
 298  *
 299  * @param other_peer peer with the other set
 300  * @param app_id hash for the application using the set
 301  * @param context_msg additional information for the request
 302  * @param result_mode specified how results will be returned,
 303  *        see `enum GNUNET_SET_ResultMode`.
 304  * @param result_cb called on error or success
 305  * @param result_cls closure for @a result_cb
 306  * @return a handle to cancel the operation
 307  */
 308 struct GNUNET_SET_OperationHandle *
 309 GNUNET_SET_prepare (const struct GNUNET_PeerIdentity *other_peer,
 310                     const struct GNUNET_HashCode *app_id,
 311                     const struct GNUNET_MessageHeader *context_msg,
 312                     enum GNUNET_SET_ResultMode result_mode,
 313                     GNUNET_SET_ResultIterator result_cb,
 314                     void *result_cls);
 315
 316
 317 /**
 318  * Wait for set operation requests for the given application ID.
 319  * If the connection to the set service is lost, the listener is
 320  * re-created transparently with exponential backoff.
 321  *
 322  * @param cfg configuration to use for connecting to
 323  *            the set service
 324  * @param operation operation we want to listen for
 325  * @param app_id id of the application that handles set operation requests
 326  * @param listen_cb called for each incoming request matching the operation
 327  *                  and application id
 328  * @param listen_cls handle for @a listen_cb
 329  * @return a handle that can be used to cancel the listen operation
 330  */
 331 struct GNUNET_SET_ListenHandle *
 332 GNUNET_SET_listen (const struct GNUNET_CONFIGURATION_Handle *cfg,
 333                    enum GNUNET_SET_OperationType op_type,
 334                    const struct GNUNET_HashCode *app_id,
 335                    GNUNET_SET_ListenCallback listen_cb,
 336                    void *listen_cls);
 337
 338
 339 /**
 340  * Cancel the given listen operation.  After calling cancel, the
 341  * listen callback for this listen handle will not be called again.
 342  *
 343  * @param lh handle for the listen operation
 344  */
 345 void
 346 GNUNET_SET_listen_cancel (struct GNUNET_SET_ListenHandle *lh);
 347
 348
 349 /**
 350  * Accept a request we got via GNUNET_SET_listen().  Must be called during
 351  * GNUNET_SET_listen(), as the `struct GNUNET_SET_Request` becomes invalid
 352  * afterwards.
 353  * Call GNUNET_SET_commit() to provide the local set to use for the operation,
 354  * and to begin the exchange with the remote peer.
 355  *
 356  * @param request request to accept
 357  * @param result_mode specified how results will be returned,
 358  *        see `enum GNUNET_SET_ResultMode`.
 359  * @param result_cb callback for the results
 360  * @param result_cls closure for @a result_cb
 361  * @return a handle to cancel the operation
 362  */
 363 struct GNUNET_SET_OperationHandle *
 364 GNUNET_SET_accept (struct GNUNET_SET_Request *request,
 365                    enum GNUNET_SET_ResultMode result_mode,
 366                    GNUNET_SET_ResultIterator result_cb,
 367                    void *result_cls);
 368
 369
 370 /**
 371  * Commit a set to be used with a set operation.
 372  * This function is called once we have fully constructed
 373  * the set that we want to use for the operation.  At this
 374  * time, the P2P protocol can then begin to exchange the
 375  * set information and call the result callback with the
 376  * result information.
 377  *
 378  * @param oh handle to the set operation
 379  * @param set the set to use for the operation
 380  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the
 381  *         set is invalid (e.g. the set service crashed)
 382  */
 383 int
 384 GNUNET_SET_commit (struct GNUNET_SET_OperationHandle *oh,
 385                    struct GNUNET_SET_Handle *set);
 386
 387
 388 /**
 389  * Cancel the given set operation.  May not be called after the
 390  * operation's `GNUNET_SET_ResultIterator` has been called with a
 391  * status that indicates error, timeout or done.
 392  *
 393  * @param oh set operation to cancel
 394  */
 395 void
 396 GNUNET_SET_operation_cancel (struct GNUNET_SET_OperationHandle *oh);
 397
 398
 399 /**
 400  * Iterate over all elements in the given set.
 401  * Note that this operation involves transferring every element of the set
 402  * from the service to the client, and is thus costly.
 403  * Only one iteration per set may be active at the same time.
 404  *
 405  * @param set the set to iterate over
 406  * @param iter the iterator to call for each element
 407  * @param iter_cls closure for @a iter
 408  * @return #GNUNET_YES if the iteration started successfuly,
 409  *         #GNUNET_NO if another iteration was still active,
 410  *         #GNUNET_SYSERR if the set is invalid (e.g. the server crashed, disconnected)
 411  */
 412 int
 413 GNUNET_SET_iterate (struct GNUNET_SET_Handle *set,
 414                     GNUNET_SET_ElementIterator iter,
 415                     void *iter_cls);
 416
 417 /**
 418  * Stop iteration over all elements in the given set.  Can only
 419  * be called before the iteration has "naturally" completed its
 420  * turn.
 421  *
 422  * @param set the set to stop iterating over
 423  */
 424 void
 425 GNUNET_SET_iterate_cancel (struct GNUNET_SET_Handle *set);
 426
 427
 428 #if 0                           /* keep Emacsens' auto-indent happy */
 429 {
 430 #endif
 431 #ifdef __cplusplus
 432 }
 433 #endif
 434
 435 #endif