gnunet_set_service.h

Go to the documentation of this file.

/*
      This file is part of GNUnet
      Copyright (C) 2013, 2014 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_SET_SERVICE_H
#define GNUNET_SET_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_SET_CONTEXT_MESSAGE_MAX_SIZE ((1 << 16) - 1024)
 
 
struct GNUNET_SET_Handle;
 
struct GNUNET_SET_Request;
 
struct GNUNET_SET_ListenHandle;
 
struct GNUNET_SET_OperationHandle;
 
 
enum GNUNET_SET_OperationType
{
  GNUNET_SET_OPERATION_NONE,
 
  GNUNET_SET_OPERATION_INTERSECTION,
 
  GNUNET_SET_OPERATION_UNION
};
 
 
enum GNUNET_SET_Status
{
  GNUNET_SET_STATUS_OK,
 
  GNUNET_SET_STATUS_ADD_LOCAL,
 
  GNUNET_SET_STATUS_ADD_REMOTE,
 
  GNUNET_SET_STATUS_FAILURE,
 
  GNUNET_SET_STATUS_HALF_DONE,
 
  GNUNET_SET_STATUS_DONE
};
 
 
enum GNUNET_SET_ResultMode
{
  GNUNET_SET_RESULT_FULL,
 
  GNUNET_SET_RESULT_SYMMETRIC,
 
  GNUNET_SET_RESULT_REMOVED,
 
  GNUNET_SET_RESULT_ADDED
};
 
 
struct GNUNET_SET_Element
{
  uint16_t size;
 
  uint16_t element_type;
 
  const void *data;
};
 
 
enum GNUNET_SET_OptionType
{
  GNUNET_SET_OPTION_END=0,
  GNUNET_SET_OPTION_BYZANTINE=1,
  GNUNET_SET_OPTION_FORCE_FULL=2,
  GNUNET_SET_OPTION_FORCE_DELTA=4,
};
 
 
struct GNUNET_SET_Option
{
  enum GNUNET_SET_OptionType type;
 
  union
  {
    uint64_t num;
  } v;
};
 
 
typedef void
(*GNUNET_SET_Continuation) (void *cls);
 
 
typedef void
(*GNUNET_SET_ResultIterator) (void *cls,
                              const struct GNUNET_SET_Element *element,
                              uint64_t current_size,
                              enum GNUNET_SET_Status status);
 
typedef int
(*GNUNET_SET_ElementIterator) (void *cls,
                               const struct GNUNET_SET_Element *element);
 
 
typedef void
(*GNUNET_SET_ListenCallback) (void *cls,
                              const struct GNUNET_PeerIdentity *other_peer,
                              const struct GNUNET_MessageHeader *context_msg,
                              struct GNUNET_SET_Request *request);
 
 
typedef void
(*GNUNET_SET_CopyReadyCallback) (void *cls,
                                 struct GNUNET_SET_Handle *copy);
 
 
struct GNUNET_SET_Handle *
GNUNET_SET_create (const struct GNUNET_CONFIGURATION_Handle *cfg,
                   enum GNUNET_SET_OperationType op);
 
 
int
GNUNET_SET_add_element (struct GNUNET_SET_Handle *set,
                        const struct GNUNET_SET_Element *element,
                        GNUNET_SET_Continuation cont,
                        void *cont_cls);
 
 
int
GNUNET_SET_remove_element (struct GNUNET_SET_Handle *set,
                           const struct GNUNET_SET_Element *element,
                           GNUNET_SET_Continuation cont,
                           void *cont_cls);
 
 
void
GNUNET_SET_copy_lazy (struct GNUNET_SET_Handle *set,
                      GNUNET_SET_CopyReadyCallback cb,
                      void *cls);
 
 
void
GNUNET_SET_destroy (struct GNUNET_SET_Handle *set);
 
 
struct GNUNET_SET_OperationHandle *
GNUNET_SET_prepare (const struct GNUNET_PeerIdentity *other_peer,
                    const struct GNUNET_HashCode *app_id,
                    const struct GNUNET_MessageHeader *context_msg,
                    enum GNUNET_SET_ResultMode result_mode,
                    struct GNUNET_SET_Option options[],
                    GNUNET_SET_ResultIterator result_cb,
                    void *result_cls);
 
 
struct GNUNET_SET_ListenHandle *
GNUNET_SET_listen (const struct GNUNET_CONFIGURATION_Handle *cfg,
                   enum GNUNET_SET_OperationType op_type,
                   const struct GNUNET_HashCode *app_id,
                   GNUNET_SET_ListenCallback listen_cb,
                   void *listen_cls);
 
 
void
GNUNET_SET_listen_cancel (struct GNUNET_SET_ListenHandle *lh);
 
 
struct GNUNET_SET_OperationHandle *
GNUNET_SET_accept (struct GNUNET_SET_Request *request,
                   enum GNUNET_SET_ResultMode result_mode,
                   struct GNUNET_SET_Option options[],
                   GNUNET_SET_ResultIterator result_cb,
                   void *result_cls);
 
 
int
GNUNET_SET_commit (struct GNUNET_SET_OperationHandle *oh,
                   struct GNUNET_SET_Handle *set);
 
 
void
GNUNET_SET_operation_cancel (struct GNUNET_SET_OperationHandle *oh);
 
 
int
GNUNET_SET_iterate (struct GNUNET_SET_Handle *set,
                    GNUNET_SET_ElementIterator iter,
                    void *iter_cls);
 
 
void
GNUNET_SET_iterate_cancel (struct GNUNET_SET_Handle *set);
 
 
struct GNUNET_SET_Element *
GNUNET_SET_element_dup (const struct GNUNET_SET_Element *element);
 
 
void
GNUNET_SET_element_hash (const struct GNUNET_SET_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 */