gnunet_setu_service.h

Go to the documentation of this file.

/*
      This file is part of GNUnet
      Copyright (C) 2013, 2014, 2020 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_SETU_SERVICE_H
#define GNUNET_SETU_SERVICE_H
 
#ifdef __cplusplus
extern "C"
{
#if 0                           /* keep Emacsens' auto-indent happy */
}
#endif
#endif
 
 
#include "gnunet_common.h"
#include "gnunet_time_lib.h"
#include "gnunet_configuration_lib.h"
 
 
#define GNUNET_SETU_CONTEXT_MESSAGE_MAX_SIZE ((1 << 16) - 1024)
 
struct GNUNET_SETU_Handle;
 
struct GNUNET_SETU_Request;
 
struct GNUNET_SETU_ListenHandle;
 
struct GNUNET_SETU_OperationHandle;
 
 
enum GNUNET_SETU_Status
{
 
  GNUNET_SETU_STATUS_ADD_LOCAL,
 
  GNUNET_SETU_STATUS_ADD_REMOTE,
 
  GNUNET_SETU_STATUS_FAILURE,
 
  GNUNET_SETU_STATUS_DONE
};
 
 
struct GNUNET_SETU_Element
{
  uint16_t size;
 
  uint16_t element_type;
 
  const void *data;
};
 
 
enum GNUNET_SETU_OptionType
{
  GNUNET_SETU_OPTION_END=0,
 
  GNUNET_SETU_OPTION_BYZANTINE=1,
 
  GNUNET_SETU_OPTION_FORCE_FULL=2,
 
  GNUNET_SETU_OPTION_FORCE_DELTA=4,
 
  GNUNET_SETU_OPTION_SYMMETRIC = 8,
 
  GNUNET_SETU_OPTION_CUSTOM_BYZANTINE_UPPER_BOUND = 16,
 
  GNUNET_SETU_OPTION_CUSTOM_BANDWIDTH_LATENCY_TRADEOFF= 32,
 
    GNUNET_SETU_OPTION_CUSTOM_IBF_BUCKET_NUMBER_FACTOR= 64,
 
    GNUNET_SETU_OPTION_CUSTOM_IBF_BUCKETS_PER_ELEMENT= 128
};
 
 
struct GNUNET_SETU_Option
{
  enum GNUNET_SETU_OptionType type;
 
  union
  {
    uint64_t num;
  } v;
};
 
 
typedef void
(*GNUNET_SETU_ResultIterator) (void *cls,
                               const struct GNUNET_SETU_Element *element,
                               uint64_t current_size,
                               enum GNUNET_SETU_Status status);
 
 
typedef void
(*GNUNET_SETU_ListenCallback) (void *cls,
                               const struct GNUNET_PeerIdentity *other_peer,
                               const struct GNUNET_MessageHeader *context_msg,
                               struct GNUNET_SETU_Request *request);
 
 
struct GNUNET_SETU_Handle *
GNUNET_SETU_create (const struct GNUNET_CONFIGURATION_Handle *cfg);
 
 
int
GNUNET_SETU_add_element (struct GNUNET_SETU_Handle *set,
                         const struct GNUNET_SETU_Element *element,
                         GNUNET_SCHEDULER_TaskCallback cb,
                         void *cb_cls);
 
 
void
GNUNET_SETU_destroy (struct GNUNET_SETU_Handle *set);
 
 
struct GNUNET_SETU_OperationHandle *
GNUNET_SETU_prepare (const struct GNUNET_PeerIdentity *other_peer,
                     const struct GNUNET_HashCode *app_id,
                     const struct GNUNET_MessageHeader *context_msg,
                     const struct GNUNET_SETU_Option options[],
                     GNUNET_SETU_ResultIterator result_cb,
                     void *result_cls);
 
 
struct GNUNET_SETU_ListenHandle *
GNUNET_SETU_listen (const struct GNUNET_CONFIGURATION_Handle *cfg,
                    const struct GNUNET_HashCode *app_id,
                    GNUNET_SETU_ListenCallback listen_cb,
                    void *listen_cls);
 
 
void
GNUNET_SETU_listen_cancel (struct GNUNET_SETU_ListenHandle *lh);
 
 
struct GNUNET_SETU_OperationHandle *
GNUNET_SETU_accept (struct GNUNET_SETU_Request *request,
                    const struct GNUNET_SETU_Option options[],
                    GNUNET_SETU_ResultIterator result_cb,
                    void *result_cls);
 
 
int
GNUNET_SETU_commit (struct GNUNET_SETU_OperationHandle *oh,
                    struct GNUNET_SETU_Handle *set);
 
 
void
GNUNET_SETU_operation_cancel (struct GNUNET_SETU_OperationHandle *oh);
 
 
void
GNUNET_SETU_element_hash (const struct GNUNET_SETU_Element *element,
                          struct GNUNET_HashCode *ret_hash);
 
 
#if 0                           /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
 
#endif
  /* end of group */
 /* end of group addition */