src/include/gnunet_datacache_lib.h

   1 /*
   2      This file is part of GNUnet
   3      (C) 2006, 2009 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_datacache_lib.h
  23  * @brief datacache is a simple, transient hash table
  24  *        of bounded size with content expiration.
  25  *        In contrast to the sqstore there is
  26  *        no prioritization, deletion or iteration.
  27  *        All of the data is discarded when the peer shuts down!
  28  * @author Christian Grothoff
  29  */
  30
  31 #ifndef GNUNET_DATACACHE_LIB_H
  32 #define GNUNET_DATACACHE_LIB_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 cache.
  48  */
  49 struct GNUNET_DATACACHE_Handle;
  50
  51
  52 /**
  53  * Create a data cache.
  54  *
  55  * @param cfg configuration to use
  56  * @param section section in the configuration that contains our options
  57  * @return handle to use to access the service
  58  */
  59 struct GNUNET_DATACACHE_Handle *
  60 GNUNET_DATACACHE_create (const struct GNUNET_CONFIGURATION_Handle *cfg,
  61                          const char *section);
  62
  63
  64 /**
  65  * Destroy a data cache (and free associated resources).
  66  *
  67  * @param h handle to the datastore
  68  */
  69 void GNUNET_DATACACHE_destroy (struct GNUNET_DATACACHE_Handle *h);
  70
  71
  72 /**
  73  * An iterator over a set of items stored in the datacache.
  74  *
  75  * @param cls closure
  76  * @param exp when will the content expire?
  77  * @param key key for the content
  78  * @param size number of bytes in data
  79  * @param data content stored
  80  * @param type type of the content
  81  * @return GNUNET_OK to continue iterating, GNUNET_SYSERR to abort
  82  */
  83 typedef int (*GNUNET_DATACACHE_Iterator) (void *cls,
  84                                           struct GNUNET_TIME_Absolute exp,
  85                                           const GNUNET_HashCode * key,
  86                                           size_t size,
  87                                           const char *data,
  88                                           enum GNUNET_BLOCK_Type type);
  89
  90
  91 /**
  92  * Store an item in the datacache.
  93  *
  94  * @param h handle to the datacache
  95  * @param key key to store data under
  96  * @param size number of bytes in data
  97  * @param data data to store
  98  * @param type type of the value
  99  * @param discard_time when to discard the value in any case
 100  * @return GNUNET_OK on success, GNUNET_SYSERR on error (full, etc.)
 101  */
 102 int
 103 GNUNET_DATACACHE_put (struct GNUNET_DATACACHE_Handle *h,
 104                       const GNUNET_HashCode * key,
 105                       size_t size,
 106                       const char *data,
 107                       enum GNUNET_BLOCK_Type type,
 108                       struct GNUNET_TIME_Absolute discard_time);
 109
 110
 111 /**
 112  * Iterate over the results for a particular key
 113  * in the datacache.
 114  *
 115  * @param h handle to the datacache
 116  * @param key what to look up
 117  * @param type entries of which type are relevant?
 118  * @param iter maybe NULL (to just count)
 119  * @param iter_cls closure for iter
 120  * @return the number of results found
 121  */
 122 unsigned int
 123 GNUNET_DATACACHE_get (struct GNUNET_DATACACHE_Handle *h,
 124                       const GNUNET_HashCode * key,
 125                       enum GNUNET_BLOCK_Type type,
 126                       GNUNET_DATACACHE_Iterator iter,
 127                       void *iter_cls);
 128
 129
 130 #if 0                           /* keep Emacsens' auto-indent happy */
 131 {
 132 #endif
 133 #ifdef __cplusplus
 134 }
 135 #endif
 136
 137 /* end of gnunet_datacache_lib.h */
 138 #endif