gnunet_namestore_service.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_SERVICE_H
#define GNUNET_NAMESTORE_SERVICE_H
 
 
#include "gnunet_error_codes.h"
#include "gnunet_util_lib.h"
#include "gnunet_gnsrecord_lib.h"
 
#ifdef __cplusplus
extern "C"
{
#if 0                           /* keep Emacsens' auto-indent happy */
}
#endif
#endif
 
 
struct GNUNET_NAMESTORE_QueueEntry;
 
struct GNUNET_NAMESTORE_Handle;
 
struct GNUNET_NAMESTORE_ZoneIterator;
 
enum GNUNET_NAMESTORE_TxControl
{
  GNUNET_NAMESTORE_TX_BEGIN = 0,
  GNUNET_NAMESTORE_TX_COMMIT = 1,
  GNUNET_NAMESTORE_TX_ROLLBACK = 2,
};
 
struct GNUNET_NAMESTORE_RecordInfo
{
  const char *a_label;
  unsigned int a_rd_count;
  struct GNUNET_GNSRECORD_Data *a_rd;
};
 
 
struct GNUNET_NAMESTORE_Handle *
GNUNET_NAMESTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
 
 
void
GNUNET_NAMESTORE_disconnect (struct GNUNET_NAMESTORE_Handle *h);
 
 
typedef void
(*GNUNET_NAMESTORE_ContinuationWithStatus) (void *cls,
                                            enum GNUNET_ErrorCode ec);
 
 
struct GNUNET_NAMESTORE_QueueEntry *
GNUNET_NAMESTORE_record_set_store (struct GNUNET_NAMESTORE_Handle *h,
                                   const struct
                                   GNUNET_CRYPTO_BlindablePrivateKey *pkey,
                                   const char *label,
                                   unsigned int rd_count,
                                   const struct GNUNET_GNSRECORD_Data *rd,
                                   GNUNET_NAMESTORE_ContinuationWithStatus cont,
                                   void *cont_cls);
 
struct GNUNET_NAMESTORE_QueueEntry *
GNUNET_NAMESTORE_records_store (
  struct GNUNET_NAMESTORE_Handle *h,
  const struct GNUNET_CRYPTO_BlindablePrivateKey *pkey,
  unsigned int rd_set_count,
  const struct GNUNET_NAMESTORE_RecordInfo *record_info,
  unsigned int *rds_sent,
  GNUNET_NAMESTORE_ContinuationWithStatus cont,
  void *cont_cls);
 
struct GNUNET_NAMESTORE_QueueEntry *
GNUNET_NAMESTORE_record_set_store_ (struct GNUNET_NAMESTORE_Handle *h,
                                    const struct
                                    GNUNET_CRYPTO_BlindablePrivateKey *pkey,
                                    const char *label,
                                    unsigned int rd_count,
                                    const struct GNUNET_GNSRECORD_Data *rd,
                                    int is_zonemaster,
                                    GNUNET_NAMESTORE_ContinuationWithStatus cont
                                    ,
                                    void *cont_cls);
 
 
typedef void
(*GNUNET_NAMESTORE_RecordMonitor) (void *cls,
                                   const struct
                                   GNUNET_CRYPTO_BlindablePrivateKey *zone,
                                   const char *label,
                                   unsigned int rd_count,
                                   const struct GNUNET_GNSRECORD_Data *rd);
typedef void
(*GNUNET_NAMESTORE_EditRecordSetBeginCallback) (void *cls,
                                                enum GNUNET_ErrorCode ec,
                                                unsigned int rd_count,
                                                const struct
                                                GNUNET_GNSRECORD_Data *rd,
                                                const char *editor_hint);
 
typedef void
(*GNUNET_NAMESTORE_RecordSetMonitor) (void *cls,
                                      const struct
                                      GNUNET_CRYPTO_BlindablePrivateKey *zone,
                                      const char *label,
                                      unsigned int rd_count,
                                      const struct GNUNET_GNSRECORD_Data *rd,
                                      struct GNUNET_TIME_Absolute expiry);
 
 
struct GNUNET_NAMESTORE_QueueEntry *
GNUNET_NAMESTORE_records_lookup (struct GNUNET_NAMESTORE_Handle *h,
                                 const struct
                                 GNUNET_CRYPTO_BlindablePrivateKey *pkey,
                                 const char *label,
                                 GNUNET_SCHEDULER_TaskCallback error_cb,
                                 void *error_cb_cls,
                                 GNUNET_NAMESTORE_RecordMonitor rm,
                                 void *rm_cls);
 
struct GNUNET_NAMESTORE_QueueEntry *
GNUNET_NAMESTORE_records_lookup2 (struct GNUNET_NAMESTORE_Handle *h,
                                  const struct
                                  GNUNET_CRYPTO_BlindablePrivateKey *pkey,
                                  const char *label,
                                  GNUNET_SCHEDULER_TaskCallback error_cb,
                                  void *error_cb_cls,
                                  GNUNET_NAMESTORE_RecordMonitor rm,
                                  void *rm_cls,
                                  enum GNUNET_GNSRECORD_Filter filter);
 
 
struct GNUNET_NAMESTORE_QueueEntry *
GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h,
                               const struct GNUNET_CRYPTO_BlindablePrivateKey *
                               zone,
                               const struct
                               GNUNET_CRYPTO_BlindablePublicKey *value_zone,
                               GNUNET_SCHEDULER_TaskCallback error_cb,
                               void *error_cb_cls,
                               GNUNET_NAMESTORE_RecordMonitor proc,
                               void *proc_cls);
 
 
void
GNUNET_NAMESTORE_cancel (struct GNUNET_NAMESTORE_QueueEntry *qe);
 
 
struct GNUNET_NAMESTORE_ZoneIterator *
GNUNET_NAMESTORE_zone_iteration_start (struct GNUNET_NAMESTORE_Handle *h,
                                       const struct
                                       GNUNET_CRYPTO_BlindablePrivateKey *zone,
                                       GNUNET_SCHEDULER_TaskCallback error_cb,
                                       void *error_cb_cls,
                                       GNUNET_NAMESTORE_RecordMonitor proc,
                                       void *proc_cls,
                                       GNUNET_SCHEDULER_TaskCallback finish_cb,
                                       void *finish_cb_cls);
 
struct GNUNET_NAMESTORE_ZoneIterator *
GNUNET_NAMESTORE_zone_iteration_start2 (struct GNUNET_NAMESTORE_Handle *h,
                                        const struct
                                        GNUNET_CRYPTO_BlindablePrivateKey *zone,
                                        GNUNET_SCHEDULER_TaskCallback error_cb,
                                        void *error_cb_cls,
                                        GNUNET_NAMESTORE_RecordSetMonitor proc,
                                        void *proc_cls,
                                        GNUNET_SCHEDULER_TaskCallback finish_cb,
                                        void *finish_cb_cls,
                                        enum GNUNET_GNSRECORD_Filter filter);
 
 
void
GNUNET_NAMESTORE_zone_iterator_next (struct GNUNET_NAMESTORE_ZoneIterator *it,
                                     uint64_t limit);
 
 
void
GNUNET_NAMESTORE_zone_iteration_stop (struct GNUNET_NAMESTORE_ZoneIterator *it);
 
 
struct GNUNET_NAMESTORE_ZoneMonitor;
 
 
struct GNUNET_NAMESTORE_ZoneMonitor *
GNUNET_NAMESTORE_zone_monitor_start (
  const struct GNUNET_CONFIGURATION_Handle *cfg,
  const struct GNUNET_CRYPTO_BlindablePrivateKey *zone,
  int iterate_first,
  GNUNET_SCHEDULER_TaskCallback error_cb,
  void *error_cb_cls,
  GNUNET_NAMESTORE_RecordMonitor monitor,
  void *monitor_cls,
  GNUNET_SCHEDULER_TaskCallback sync_cb,
  void *sync_cb_cls);
 
struct GNUNET_NAMESTORE_ZoneMonitor *
GNUNET_NAMESTORE_zone_monitor_start2 (
  const struct GNUNET_CONFIGURATION_Handle *cfg,
  const struct GNUNET_CRYPTO_BlindablePrivateKey *zone,
  int iterate_first,
  GNUNET_SCHEDULER_TaskCallback error_cb,
  void *error_cb_cls,
  GNUNET_NAMESTORE_RecordSetMonitor monitor,
  void *monitor_cls,
  GNUNET_SCHEDULER_TaskCallback sync_cb,
  void *sync_cb_cls,
  enum GNUNET_GNSRECORD_Filter filter);
 
 
void
GNUNET_NAMESTORE_zone_monitor_next (struct GNUNET_NAMESTORE_ZoneMonitor *zm,
                                    uint64_t limit);
 
 
void
GNUNET_NAMESTORE_zone_monitor_stop (struct GNUNET_NAMESTORE_ZoneMonitor *zm);
 
 
struct GNUNET_NAMESTORE_QueueEntry *
GNUNET_NAMESTORE_record_set_edit_begin (struct GNUNET_NAMESTORE_Handle *h,
                                        const struct
                                        GNUNET_CRYPTO_BlindablePrivateKey *pkey,
                                        const char *label,
                                        const char *editor_hint,
                                        GNUNET_NAMESTORE_EditRecordSetBeginCallback
                                        edit_cb,
                                        void *edit_cb_cls);
 
struct GNUNET_NAMESTORE_QueueEntry *
GNUNET_NAMESTORE_record_set_edit_cancel (struct GNUNET_NAMESTORE_Handle *h,
                                         const struct
                                         GNUNET_CRYPTO_BlindablePrivateKey *pkey
                                         ,
                                         const char *label,
                                         const char *editor_hint,
                                         const char *editor_hint_replacement,
                                         GNUNET_NAMESTORE_ContinuationWithStatus
                                         finished_cb,
                                         void *finished_cls);
 
#if 0                           /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
 
#endif