gnunet_datacache_lib.h

Go to the documentation of this file.

/*
     This file is part of GNUnet
     Copyright (C) 2006, 2009, 2015, 2022 GNUnet e.V.
 
     GNUnet is free software: you can redistribute it and/or modify it
     under the terms of the GNU Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     or (at your option) any later version.
 
     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Affero General Public License for more details.
 
     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
#ifndef GNUNET_DATACACHE_LIB_H
#define GNUNET_DATACACHE_LIB_H
 
 
#include "gnunet_util_lib.h"
#include "gnunet_block_lib.h"
#include "gnunet_dht_service.h"
 
#ifdef __cplusplus
extern "C"
{
#if 0                           /* keep Emacsens' auto-indent happy */
}
#endif
#endif
 
 
struct GNUNET_DATACACHE_Block
{
  struct GNUNET_HashCode key;
 
  struct GNUNET_TIME_Absolute expiration_time;
 
  struct GNUNET_PeerIdentity trunc_peer;
 
  const struct GNUNET_DHT_PathElement *put_path;
 
  const void *data;
 
  size_t data_size;
 
  unsigned int put_path_length;
 
  enum GNUNET_BLOCK_Type type;
 
  enum GNUNET_DHT_RouteOption ro;
};
 
 
struct GNUNET_DATACACHE_Handle;
 
 
struct GNUNET_DATACACHE_Handle *
GNUNET_DATACACHE_create (const struct GNUNET_CONFIGURATION_Handle *cfg,
                         const char *section);
 
 
void
GNUNET_DATACACHE_destroy (struct GNUNET_DATACACHE_Handle *h);
 
 
typedef enum GNUNET_GenericReturnValue
(*GNUNET_DATACACHE_Iterator)(void *cls,
                             const struct GNUNET_DATACACHE_Block *block);
 
 
enum GNUNET_GenericReturnValue
GNUNET_DATACACHE_put (struct GNUNET_DATACACHE_Handle *h,
                      uint32_t xor_distance,
                      const struct GNUNET_DATACACHE_Block *block);
 
 
unsigned int
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);
 
 
unsigned int
GNUNET_DATACACHE_get_closest (struct GNUNET_DATACACHE_Handle *h,
                              const struct GNUNET_HashCode *key,
                              enum GNUNET_BLOCK_Type type,
                              unsigned int num_results,
                              GNUNET_DATACACHE_Iterator iter,
                              void *iter_cls);
 
 
#if 0                           /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
 
#endif
  /* end of group */
 /* end of group addition */