/*
This file is part of GNUnet
- Copyright (C) 2013, 2014 Christian Grothoff (and other contributing authors)
+ 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 General Public License as published
*/
/**
- * @file include/gnunet_set_service.h
- * @brief two-peer set operations
* @author Florian Dold
* @author Christian Grothoff
+ *
+ * @file
+ * Two-peer set operations
+ *
+ * @defgroup set Set service
+ * Two-peer set operations
+ *
+ * @see [Documentation](https://gnunet.org/set-subsystem)
+ *
+ * @{
*/
#ifndef GNUNET_SET_SERVICE_H
* Everything went ok, we are transmitting an element of the
* result (in set, or to be removed from set, depending on
* the `enum GNUNET_SET_ResultMode`).
+ *
+ * Only applies to
+ * #GNUNET_SET_RESULT_FULL,
+ * #GNUNET_SET_RESULT_ADDED,
+ * #GNUNET_SET_RESULT_REMOVED,
*/
GNUNET_SET_STATUS_OK,
+ /**
+ * Element should be added to the result set
+ * of the local peer, i.e. the local peer is
+ * missing an element.
+ *
+ * Only applies to #GNUNET_SET_RESULT_SYMMETRIC
+ */
+ GNUNET_SET_STATUS_ADD_LOCAL,
+
+ /**
+ * Element should be added to the result set
+ * of the remote peer, i.e. the remote peer is
+ * missing an element.
+ *
+ * Only applies to #GNUNET_SET_RESULT_SYMMETRIC
+ */
+ GNUNET_SET_STATUS_ADD_REMOTE,
+
/**
* The other peer refused to to the operation with us,
* or something went wrong.
};
+
/**
* The way results are given to the client.
*/
{
/**
* Client gets every element in the resulting set.
+ *
+ * Only supported for set intersection.
*/
GNUNET_SET_RESULT_FULL,
/**
- * Client gets only elements that have been added to the set.
- * Only works with set union.
+ * Client gets notified of the required changes
+ * for both the local and the remote set.
+ *
+ * Only supported for set
*/
- GNUNET_SET_RESULT_ADDED,
+ GNUNET_SET_RESULT_SYMMETRIC,
/**
* Client gets only elements that have been removed from the set.
- * Only works with set intersection.
+ *
+ * Only supported for set intersection.
*/
- GNUNET_SET_RESULT_REMOVED
+ GNUNET_SET_RESULT_REMOVED,
+
+ /**
+ * Client gets only elements that have been added to the set.
+ *
+ * Only supported for set union.
+ */
+ GNUNET_SET_RESULT_ADDED
};
};
+/**
+ * Possible options to pass to a set operation.
+ *
+ * Used as tag for struct #GNUNET_SET_Option.
+ */
+enum GNUNET_SET_OptionType
+{
+ /**
+ * List terminator.
+ */
+ GNUNET_SET_OPTION_END=0,
+ /**
+ * Fail set operations when the other peer shows weird behavior
+ * that might by a Byzantine fault.
+ *
+ * For set union, 'v.num' is a lower bound on elements
+ * that the other peer must have in common with us.
+ */
+ GNUNET_SET_OPTION_BYZANTINE=1,
+ /**
+ * Do not use the optimized set operation, but send full sets.
+ * Might trigger Byzantine fault detection.
+ */
+ GNUNET_SET_OPTION_FORCE_FULL=2,
+ /**
+ * Only use optimized set operations, even though for this
+ * particular set operation they might be much slower.
+ * Might trigger Byzantine fault detection.
+ */
+ GNUNET_SET_OPTION_FORCE_DELTA=4,
+};
+
+
+/**
+ * Option for set operations.
+ */
+struct GNUNET_SET_Option
+{
+ /**
+ * Type of the option.
+ */
+ enum GNUNET_SET_OptionType type;
+
+ /**
+ * Value for the option, only used with some options.
+ */
+ union {
+ uint64_t num;
+ } v;
+};
+
+
/**
* Continuation used for some of the set operations
*
* @param cls closure
*/
-typedef void (*GNUNET_SET_Continuation) (void *cls);
+typedef void
+(*GNUNET_SET_Continuation) (void *cls);
/**
*
* @param cls closure
* @param element a result element, only valid if status is #GNUNET_SET_STATUS_OK
+ * @param current_size current set size
* @param status see `enum GNUNET_SET_Status`
*/
-typedef void (*GNUNET_SET_ResultIterator) (void *cls,
- const struct GNUNET_SET_Element *element,
- enum GNUNET_SET_Status status);
+typedef void
+(*GNUNET_SET_ResultIterator) (void *cls,
+ const struct GNUNET_SET_Element *element,
+ uint64_t current_size,
+ enum GNUNET_SET_Status status);
/**
* Iterator for set elements.
* iterated over
* @return #GNUNET_YES to continue iterating, #GNUNET_NO to stop.
*/
-typedef int (*GNUNET_SET_ElementIterator) (void *cls,
- const struct GNUNET_SET_Element *element);
+typedef int
+(*GNUNET_SET_ElementIterator) (void *cls,
+ const struct GNUNET_SET_Element *element);
/**
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_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);
void
GNUNET_SET_iterate_cancel (struct GNUNET_SET_Handle *set);
+/**
+ * Create a copy of an element. The copy
+ * must be GNUNET_free-d by the caller.
+ *
+ * @param element the element to copy
+ * @return the copied element
+ */
+struct GNUNET_SET_Element *
+GNUNET_SET_element_dup (const struct GNUNET_SET_Element *element);
+
+/**
+ * Hash a set element.
+ *
+ * @param element the element that should be hashed
+ * @param ret_hash a pointer to where the hash of @a element
+ * should be stored
+ */
+void
+GNUNET_SET_element_hash (const struct GNUNET_SET_Element *element, struct GNUNET_HashCode *ret_hash);
+
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#endif
+
+/** @} */ /* end of group */
projects / oweals / gnunet.git / blobdiff