src/dht/gnunet-service-wdht_datacache.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2009, 2010, 2011 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 dht/gnunet-service-dht_datacache.h
  23  * @brief GNUnet DHT service's datacache integration
  24  * @author Christian Grothoff
  25  * @author Nathan Evans
  26  */
  27 #ifndef GNUNET_SERVICE_DHT_DATACACHE_H
  28 #define GNUNET_SERVICE_DHT_DATACACHE_H
  29
  30 #include "gnunet_util_lib.h"
  31 #include "gnunet_block_lib.h"
  32
  33 /**
  34  * Handle a datum we've received from another peer.  Cache if
  35  * possible.
  36  *
  37  * @param expiration when will the reply expire
  38  * @param key the query this reply is for
  39  * @param put_path_length number of peers in @a put_path
  40  * @param put_path path the reply took on put
  41  * @param type type of the reply
  42  * @param data_size number of bytes in @a data
  43  * @param data application payload data
  44  */
  45 void
  46 GDS_DATACACHE_handle_put (struct GNUNET_TIME_Absolute expiration,
  47                           const struct GNUNET_HashCode *key,
  48                           unsigned int put_path_length,
  49                           const struct GNUNET_PeerIdentity *put_path,
  50                           enum GNUNET_BLOCK_Type type, size_t data_size,
  51                           const void *data);
  52
  53
  54 /**
  55  * Handle a GET request we've received from another peer.
  56  *
  57  * @param key the query
  58  * @param type requested data type
  59  * @param xquery extended query
  60  * @param xquery_size number of bytes in @a xquery
  61  * @param reply_bf where the reply bf is (to be) stored, possibly updated!, can be NULL
  62  * @param reply_bf_mutator mutation value for @a reply_bf
  63  * @return evaluation result for the local replies
  64  */
  65 enum GNUNET_BLOCK_EvaluationResult
  66 GDS_DATACACHE_handle_get (const struct GNUNET_HashCode *key,
  67                           enum GNUNET_BLOCK_Type type,
  68                           const void *xquery,
  69                           size_t xquery_size,
  70                           struct GNUNET_CONTAINER_BloomFilter **reply_bf,
  71                           uint32_t reply_bf_mutator,
  72                           uint32_t get_path_length,
  73                           struct GNUNET_PeerIdentity *get_path,
  74                           struct GNUNET_PeerIdentity *next_hop,
  75                           struct GNUNET_PeerIdentity *source_peer);
  76
  77
  78 /**
  79  * Obtain a random key from the datacache.
  80  * Used by Whanau for load-balancing.
  81  *
  82  * @param[out] key where to store the key of a random element,
  83  *             randomized by PRNG if datacache is empty
  84  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the datacache is empty
  85  */
  86 int
  87 GDS_DATACACHE_get_random_key (struct GNUNET_HashCode *key);
  88
  89
  90 /**
  91  * Initialize datacache subsystem.
  92  */
  93 void
  94 GDS_DATACACHE_init (void);
  95
  96
  97 /**
  98  * Shutdown datacache subsystem.
  99  */
 100 void
 101 GDS_DATACACHE_done (void);
 102
 103 #endif