gnunet_datacache_plugin.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 PLUGIN_DATACACHE_H
#define PLUGIN_DATACACHE_H
 
 
#include "gnunet_datacache_lib.h"
 
#ifdef __cplusplus
extern "C"
{
#if 0                           /* keep Emacsens' auto-indent happy */
}
#endif
#endif
 
 
typedef void
(*GNUNET_DATACACHE_DeleteNotifyCallback) (void *cls,
                                          const struct GNUNET_HashCode *key,
                                          size_t size);
 
 
struct GNUNET_DATACACHE_PluginEnvironment
{
  const struct GNUNET_CONFIGURATION_Handle *cfg;
 
  const char *section;
 
  void *cls;
 
  GNUNET_DATACACHE_DeleteNotifyCallback delete_notify;
 
  unsigned long long quota;
};
 
 
struct GNUNET_DATACACHE_PluginFunctions
{
  void *cls;
 
  ssize_t
  (*put) (void *cls,
          uint32_t xor_distance,
          const struct GNUNET_DATACACHE_Block *block);
 
 
  unsigned int
  (*get) (void *cls,
          const struct GNUNET_HashCode *key,
          enum GNUNET_BLOCK_Type type,
          GNUNET_DATACACHE_Iterator iter,
          void *iter_cls);
 
 
  enum GNUNET_GenericReturnValue
  (*del)(void *cls);
 
 
  unsigned int
  (*get_closest) (void *cls,
                  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 */