gnunet_namestore_plugin.h

Go to the documentation of this file.

/*
     This file is part of GNUnet
     Copyright (C) 2012, 2013, 2018 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_NAMESTORE_PLUGIN_H
#define GNUNET_NAMESTORE_PLUGIN_H
 
 
#include "gnunet_util_lib.h"
#include "gnunet_namestore_service.h"
 
#ifdef __cplusplus
extern "C"
{
#if 0                           /* keep Emacsens' auto-indent happy */
}
#endif
#endif
 
 
typedef void
(*GNUNET_NAMESTORE_RecordIterator) (void *cls,
                                    uint64_t serial,
                                    const char *editor_hint,
                                    const struct
                                    GNUNET_CRYPTO_PrivateKey *private_key,
                                    const char *label,
                                    unsigned int rd_count,
                                    const struct GNUNET_GNSRECORD_Data *rd);
 
 
struct GNUNET_NAMESTORE_PluginFunctions
{
  void *cls;
 
  enum GNUNET_GenericReturnValue
  (*store_records)(void *cls,
                   const struct GNUNET_CRYPTO_PrivateKey *zone,
                   const char *label,
                   unsigned int rd_count,
                   const struct GNUNET_GNSRECORD_Data *rd);
 
  enum GNUNET_GenericReturnValue
  (*lookup_records)(void *cls,
                    const struct GNUNET_CRYPTO_PrivateKey *zone,
                    const char *label,
                    GNUNET_NAMESTORE_RecordIterator iter,
                    void *iter_cls);
 
 
  enum GNUNET_GenericReturnValue
  (*iterate_records)(void *cls,
                     const struct GNUNET_CRYPTO_PrivateKey *zone,
                     uint64_t serial,
                     uint64_t limit,
                     GNUNET_NAMESTORE_RecordIterator iter,
                     void *iter_cls);
 
 
  enum GNUNET_GenericReturnValue
  (*zone_to_name)(void *cls,
                  const struct GNUNET_CRYPTO_PrivateKey *zone,
                  const struct GNUNET_CRYPTO_PublicKey *value_zone,
                  GNUNET_NAMESTORE_RecordIterator iter,
                  void *iter_cls);
 
  enum GNUNET_GenericReturnValue
  (*edit_records)(void *cls,
                  const char *editor_hint,
                  const struct GNUNET_CRYPTO_PrivateKey *zone,
                  const char *label,
                  GNUNET_NAMESTORE_RecordIterator iter,
                  void *iter_cls);
 
  enum GNUNET_GenericReturnValue
  (*clear_editor_hint)(void *cls,
                  const char *editor_hint,
                  const char *editor_hint_replacement,
                  const struct GNUNET_CRYPTO_PrivateKey *zone,
                       const char *label);
 
  enum GNUNET_GenericReturnValue
  (*begin_tx)(void *cls);
 
  enum GNUNET_GenericReturnValue
  (*commit_tx)(void *cls);
 
  enum GNUNET_GenericReturnValue
  (*rollback_tx)(void *cls);
 
  enum GNUNET_GenericReturnValue
  (*create_tables)(void *cls);
 
 
  enum GNUNET_GenericReturnValue
  (*drop_tables)(void *cls);
};
 
 
#if 0                           /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
 
#endif
  /* end of group */
 /* end of group addition */