/*
This file is part of GNUnet
- Copyright (C) 2006, 2009, 2015 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2006, 2009, 2015 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
- * @file include/gnunet_datacache_lib.h
- * @brief datacache is a simple, transient hash table
- * of bounded size with content expiration.
- * In contrast to the sqstore there is
- * no prioritization, deletion or iteration.
- * All of the data is discarded when the peer shuts down!
* @author Christian Grothoff
+ *
+ * @file
+ * datacache API
+ *
+ * @defgroup datacache Data Cache library
+ * Simple, transient hash table of bounded size with content expiration.
+ *
+ * In contrast to the sqstore there is
+ * no prioritization, deletion or iteration.
+ * All of the data is discarded when the peer shuts down!
+ *
+ * @{
*/
#ifndef GNUNET_DATACACHE_LIB_H
GNUNET_DATACACHE_get (struct GNUNET_DATACACHE_Handle *h,
const struct GNUNET_HashCode *key,
enum GNUNET_BLOCK_Type type,
- GNUNET_DATACACHE_Iterator iter, void *iter_cls);
+ GNUNET_DATACACHE_Iterator iter,
+ void *iter_cls);
/**
void *iter_cls);
+/**
+ * Iterate over the results that are "close" to a particular key in
+ * the datacache. "close" is defined as numerically larger than @a
+ * key (when interpreted as a circular address space), with small
+ * distance.
+ *
+ * @param h handle to the datacache
+ * @param key area of the keyspace to look into
+ * @param num_results number of results that should be returned to @a iter
+ * @param iter maybe NULL (to just count)
+ * @param iter_cls closure for @a iter
+ * @return the number of results found
+ */
+unsigned int
+GNUNET_DATACACHE_get_closest (struct GNUNET_DATACACHE_Handle *h,
+ const struct GNUNET_HashCode *key,
+ unsigned int num_results,
+ GNUNET_DATACACHE_Iterator iter,
+ void *iter_cls);
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
-/* end of gnunet_datacache_lib.h */
#endif
+
+/** @} */ /* end of group */