gnunet_datastore_plugin.h

Go to the documentation of this file.

/*
     This file is part of GNUnet
     Copyright (C) 2009, 2011 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_DATASTORE_H
#define PLUGIN_DATASTORE_H
 
 
#include "gnunet_block_lib.h"
#include "gnunet_configuration_lib.h"
#include "gnunet_datastore_service.h"
#include "gnunet_statistics_service.h"
#include "gnunet_scheduler_lib.h"
 
 
#define GNUNET_DATASTORE_ENTRY_OVERHEAD 256
 
 
typedef void
(*GNUNET_DATASTORE_DiskUtilizationChange) (void *cls,
                                           int delta);
 
 
struct GNUNET_DATASTORE_PluginEnvironment
{
  const struct GNUNET_CONFIGURATION_Handle *cfg;
 
  GNUNET_DATASTORE_DiskUtilizationChange duc;
 
  void *cls;
};
 
 
typedef enum GNUNET_GenericReturnValue
(*PluginDatumProcessor)(void *cls,
                        const struct GNUNET_HashCode *key,
                        uint32_t size,
                        const void *data,
                        enum GNUNET_BLOCK_Type type,
                        uint32_t priority,
                        uint32_t anonymity,
                        uint32_t replication,
                        struct GNUNET_TIME_Absolute expiration,
                        uint64_t uid);
 
 
typedef void
(*PluginEstimateSize) (void *cls,
                       unsigned long long *estimate);
 
 
typedef void
(*PluginPutCont) (void *cls,
                  const struct GNUNET_HashCode *key,
                  uint32_t size,
                  int status,
                  const char *msg);
 
 
typedef void
(*PluginPut) (void *cls,
              const struct GNUNET_HashCode *key,
              bool absent,
              uint32_t size,
              const void *data,
              enum GNUNET_BLOCK_Type type,
              uint32_t priority,
              uint32_t anonymity,
              uint32_t replication,
              struct GNUNET_TIME_Absolute expiration,
              PluginPutCont cont,
              void *cont_cls);
 
 
typedef void
(*PluginKeyProcessor) (void *cls,
                       const struct GNUNET_HashCode *key,
                       unsigned int count);
 
 
typedef void
(*PluginGetKeys) (void *cls,
                  PluginKeyProcessor proc,
                  void *proc_cls);
 
 
typedef void
(*PluginGetKey) (void *cls,
                 uint64_t next_uid,
                 bool random,
                 const struct GNUNET_HashCode *key,
                 enum GNUNET_BLOCK_Type type,
                 PluginDatumProcessor proc,
                 void *proc_cls);
 
 
typedef void
(*PluginRemoveCont) (void *cls,
                     const struct GNUNET_HashCode *key,
                     uint32_t size,
                     int status,
                     const char *msg);
 
 
typedef void
(*PluginRemoveKey) (void *cls,
                    const struct GNUNET_HashCode *key,
                    uint32_t size,
                    const void *data,
                    PluginRemoveCont cont,
                    void *cont_cls);
 
 
typedef void
(*PluginGetRandom) (void *cls,
                    PluginDatumProcessor proc,
                    void *proc_cls);
 
 
typedef void
(*PluginGetType) (void *cls,
                  uint64_t next_uid,
                  enum GNUNET_BLOCK_Type type,
                  PluginDatumProcessor proc,
                  void *proc_cls);
 
 
typedef void
(*PluginDrop) (void *cls);
 
 
struct GNUNET_DATASTORE_PluginFunctions
{
  void *cls;
 
  PluginEstimateSize estimate_size;
 
  PluginPut put;
 
  PluginGetKey get_key;
 
  PluginGetType get_zero_anonymity;
 
  PluginGetRandom get_replication;
 
  PluginGetRandom get_expiration;
 
  PluginDrop drop;
 
  PluginGetKeys get_keys;
 
  PluginRemoveKey remove_key;
};
 
#endif
  /* end of group */
 /* end of group addition */