src/include/gnunet_datastore_service.h

   1 /*
   2      This file is part of GNUnet
   3      (C) 2004, 2005, 2006, 2007, 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 include/gnunet_datastore_service.h
  23  * @brief API that can be used manage the
  24  *   datastore for files stored on a GNUnet node;
  25  *   note that the datastore is NOT responsible for
  26  *   on-demand encoding, that is achieved using
  27  *   a special kind of entry.
  28  * @author Christian Grothoff
  29  */
  30
  31 #ifndef GNUNET_DATASTORE_SERVICE_H
  32 #define GNUNET_DATASTORE_SERVICE_H
  33
  34 #include "gnunet_util_lib.h"
  35 #include "gnunet_block_lib.h"
  36
  37 #ifdef __cplusplus
  38 extern "C"
  39 {
  40 #if 0                           /* keep Emacsens' auto-indent happy */
  41 }
  42 #endif
  43 #endif
  44
  45
  46 /**
  47  * Handle to the datastore service.
  48  */
  49 struct GNUNET_DATASTORE_Handle;
  50
  51
  52 /**
  53  * Connect to the datastore service.
  54  *
  55  * @param cfg configuration to use
  56  * @param sched scheduler to use
  57  * @return handle to use to access the service
  58  */
  59 struct GNUNET_DATASTORE_Handle *GNUNET_DATASTORE_connect (const struct
  60                                                           GNUNET_CONFIGURATION_Handle
  61                                                           *cfg,
  62                                                           struct
  63                                                           GNUNET_SCHEDULER_Handle
  64                                                           *sched);
  65
  66
  67 /**
  68  * Disconnect from the datastore service (and free
  69  * associated resources).
  70  *
  71  * @param h handle to the datastore
  72  * @param drop set to GNUNET_YES to delete all data in datastore (!)
  73  */
  74 void GNUNET_DATASTORE_disconnect (struct GNUNET_DATASTORE_Handle *h,
  75                                   int drop);
  76
  77
  78 /**
  79  * Continuation called to notify client about result of the
  80  * operation.
  81  *
  82  * @param cls closure
  83  * @param success GNUNET_SYSERR on failure,
  84  *                GNUNET_NO on timeout/queue drop
  85  *                GNUNET_YES on success
  86  * @param msg NULL on success, otherwise an error message
  87  */
  88 typedef void (*GNUNET_DATASTORE_ContinuationWithStatus)(void *cls,
  89                                                         int success,
  90                                                         const char *msg);
  91
  92
  93 /**
  94  * Reserve space in the datastore.  This function should be used
  95  * to avoid "out of space" failures during a longer sequence of "put"
  96  * operations (for example, when a file is being inserted).
  97  *
  98  * @param h handle to the datastore
  99  * @param amount how much space (in bytes) should be reserved (for content only)
 100  * @param entries how many entries will be created (to calculate per-entry overhead)
 101  * @param queue_priority ranking of this request in the priority queue
 102  * @param max_queue_size at what queue size should this request be dropped
 103  *        (if other requests of higher priority are in the queue)
 104  * @param timeout how long to wait at most for a response (or before dying in queue)
 105  * @param cont continuation to call when done; "success" will be set to
 106  *             a positive reservation value if space could be reserved.
 107  * @param cont_cls closure for cont
 108  */
 109 void
 110 GNUNET_DATASTORE_reserve (struct GNUNET_DATASTORE_Handle *h,
 111                           uint64_t amount,
 112                           uint32_t entries,
 113                           unsigned int queue_priority,
 114                           unsigned int max_queue_size,
 115                           struct GNUNET_TIME_Relative timeout,
 116                           GNUNET_DATASTORE_ContinuationWithStatus cont,
 117                           void *cont_cls);
 118
 119
 120 /**
 121  * Store an item in the datastore.  If the item is already present,
 122  * the priorities are summed up and the higher expiration time and
 123  * lower anonymity level is used.
 124  *
 125  * @param h handle to the datastore
 126  * @param rid reservation ID to use (from "reserve"); use 0 if no
 127  *            prior reservation was made
 128  * @param key key for the value
 129  * @param size number of bytes in data
 130  * @param data content stored
 131  * @param type type of the content
 132  * @param priority priority of the content
 133  * @param anonymity anonymity-level for the content
 134  * @param expiration expiration time for the content
 135  * @param queue_priority ranking of this request in the priority queue
 136  * @param max_queue_size at what queue size should this request be dropped
 137  *        (if other requests of higher priority are in the queue)
 138  * @param timeout timeout for the operation
 139  * @param cont continuation to call when done
 140  * @param cont_cls closure for cont
 141  */
 142 void
 143 GNUNET_DATASTORE_put (struct GNUNET_DATASTORE_Handle *h,
 144                       int rid,
 145                       const GNUNET_HashCode * key,
 146                       uint32_t size,
 147                       const void *data,
 148                       enum GNUNET_BLOCK_Type type,
 149                       uint32_t priority,
 150                       uint32_t anonymity,
 151                       struct GNUNET_TIME_Absolute expiration,
 152                       unsigned int queue_priority,
 153                       unsigned int max_queue_size,
 154                       struct GNUNET_TIME_Relative timeout,
 155                       GNUNET_DATASTORE_ContinuationWithStatus cont,
 156                       void *cont_cls);
 157
 158
 159 /**
 160  * Signal that all of the data for which a reservation was made has
 161  * been stored and that whatever excess space might have been reserved
 162  * can now be released.
 163  *
 164  * @param h handle to the datastore
 165  * @param rid reservation ID (value of "success" in original continuation
 166  *        from the "reserve" function).
 167  * @param queue_priority ranking of this request in the priority queue
 168  * @param max_queue_size at what queue size should this request be dropped
 169  *        (if other requests of higher priority are in the queue)
 170  * @param queue_priority ranking of this request in the priority queue
 171  * @param max_queue_size at what queue size should this request be dropped
 172  *        (if other requests of higher priority are in the queue)
 173  * @param timeout how long to wait at most for a response
 174  * @param cont continuation to call when done
 175  * @param cont_cls closure for cont
 176  */
 177 void
 178 GNUNET_DATASTORE_release_reserve (struct GNUNET_DATASTORE_Handle *h,
 179                                   int rid,
 180                                   unsigned int queue_priority,
 181                                   unsigned int max_queue_size,
 182                                   struct GNUNET_TIME_Relative timeout,
 183                                   GNUNET_DATASTORE_ContinuationWithStatus cont,
 184                                   void *cont_cls);
 185
 186
 187 /**
 188  * Update a value in the datastore.
 189  *
 190  * @param h handle to the datastore
 191  * @param uid identifier for the value
 192  * @param priority how much to increase the priority of the value
 193  * @param expiration new expiration value should be MAX of existing and this argument
 194  * @param queue_priority ranking of this request in the priority queue
 195  * @param max_queue_size at what queue size should this request be dropped
 196  *        (if other requests of higher priority are in the queue)
 197  * @param timeout how long to wait at most for a response
 198  * @param cont continuation to call when done
 199  * @param cont_cls closure for cont
 200  */
 201 void
 202 GNUNET_DATASTORE_update (struct GNUNET_DATASTORE_Handle *h,
 203                          unsigned long long uid,
 204                          uint32_t priority,
 205                          struct GNUNET_TIME_Absolute expiration,
 206                          unsigned int queue_priority,
 207                          unsigned int max_queue_size,
 208                          struct GNUNET_TIME_Relative timeout,
 209                          GNUNET_DATASTORE_ContinuationWithStatus cont,
 210                          void *cont_cls);
 211
 212
 213 /**
 214  * An iterator over a set of items stored in the datastore.
 215  *
 216  * @param cls closure
 217  * @param key key for the content
 218  * @param size number of bytes in data
 219  * @param data content stored
 220  * @param type type of the content
 221  * @param priority priority of the content
 222  * @param anonymity anonymity-level for the content
 223  * @param expiration expiration time for the content
 224  * @param uid unique identifier for the datum;
 225  *        maybe 0 if no unique identifier is available
 226  */
 227 typedef void (*GNUNET_DATASTORE_Iterator) (void *cls,
 228                                            const GNUNET_HashCode * key,
 229                                            uint32_t size,
 230                                            const void *data,
 231                                            enum GNUNET_BLOCK_Type type,
 232                                            uint32_t priority,
 233                                            uint32_t anonymity,
 234                                            struct GNUNET_TIME_Absolute
 235                                            expiration, uint64_t uid);
 236
 237
 238 /**
 239  * Iterate over the results for a particular key
 240  * in the datastore.  The iterator will only be called
 241  * once initially; if the first call did contain a
 242  * result, further results can be obtained by calling
 243  * "GNUNET_DATASTORE_get_next" with the given argument.
 244  *
 245  * @param h handle to the datastore
 246  * @param key maybe NULL (to match all entries)
 247  * @param type desired type, 0 for any
 248  * @param queue_priority ranking of this request in the priority queue
 249  * @param max_queue_size at what queue size should this request be dropped
 250  *        (if other requests of higher priority are in the queue)
 251  * @param timeout how long to wait at most for a response
 252  * @param iter function to call on each matching value;
 253  *        will be called once with a NULL value at the end
 254  * @param iter_cls closure for iter
 255  */
 256 void
 257 GNUNET_DATASTORE_get (struct GNUNET_DATASTORE_Handle *h,
 258                       const GNUNET_HashCode * key,
 259                       enum GNUNET_BLOCK_Type type,
 260                       unsigned int queue_priority,
 261                       unsigned int max_queue_size,
 262                       struct GNUNET_TIME_Relative timeout,
 263                       GNUNET_DATASTORE_Iterator iter,
 264                       void *iter_cls);
 265
 266
 267 /**
 268  * Function called to trigger obtaining the next result
 269  * from the datastore.
 270  *
 271  * @param h handle to the datastore
 272  * @param more GNUNET_YES to get moxre results, GNUNET_NO to abort
 273  *        iteration (with a final call to "iter" with key/data == NULL).
 274  */
 275 void
 276 GNUNET_DATASTORE_get_next (struct GNUNET_DATASTORE_Handle *h,
 277                            int more);
 278
 279
 280 /**
 281  * Get a random value from the datastore.
 282  *
 283  * @param h handle to the datastore
 284  * @param queue_priority ranking of this request in the priority queue
 285  * @param max_queue_size at what queue size should this request be dropped
 286  *        (if other requests of higher priority are in the queue)
 287  * @param timeout how long to wait at most for a response
 288  * @param iter function to call on a random value; it
 289  *        will be called once with a value (if available)
 290  *        and always once with a value of NULL.
 291  * @param iter_cls closure for iter
 292  */
 293 void
 294 GNUNET_DATASTORE_get_random (struct GNUNET_DATASTORE_Handle *h,
 295                              unsigned int queue_priority,
 296                              unsigned int max_queue_size,
 297                              struct GNUNET_TIME_Relative timeout,
 298                              GNUNET_DATASTORE_Iterator iter,
 299                              void *iter_cls);
 300
 301
 302 /**
 303  * Explicitly remove some content from the database.
 304  * The "cont"inuation will be called with status
 305  * "GNUNET_OK" if content was removed, "GNUNET_NO"
 306  * if no matching entry was found and "GNUNET_SYSERR"
 307  * on all other types of errors.
 308  *
 309  * @param h handle to the datastore
 310  * @param key key for the value
 311  * @param size number of bytes in data
 312  * @param data content stored
 313  * @param queue_priority ranking of this request in the priority queue
 314  * @param max_queue_size at what queue size should this request be dropped
 315  *        (if other requests of higher priority are in the queue)
 316  * @param timeout how long to wait at most for a response
 317  * @param cont continuation to call when done
 318  * @param cont_cls closure for cont
 319  */
 320 void
 321 GNUNET_DATASTORE_remove (struct GNUNET_DATASTORE_Handle *h,
 322                          const GNUNET_HashCode *key,
 323                          uint32_t size,
 324                          const void *data,
 325                          unsigned int queue_priority,
 326                          unsigned int max_queue_size,
 327                          struct GNUNET_TIME_Relative timeout,
 328                          GNUNET_DATASTORE_ContinuationWithStatus cont,
 329                          void *cont_cls);
 330
 331
 332 #if 0                           /* keep Emacsens' auto-indent happy */
 333 {
 334 #endif
 335 #ifdef __cplusplus
 336 }
 337 #endif
 338
 339 /* end of gnunet_datastore_service.h */
 340 #endif