*/
enum GNUNET_SET_OperationType
{
+ /**
+ * A purely local set that does not support any
+ * operation.
+ */
+ GNUNET_SET_OPERATION_NONE,
+
/**
* Set intersection, only return elements that are in both sets.
*/
GNUNET_SET_OPERATION_INTERSECTION,
+
/**
* Set union, return all elements that are in at least one of the sets.
*/
GNUNET_SET_STATUS_DONE
};
+
/**
* The way results are given to the client.
*/
GNUNET_SET_RESULT_REMOVED
};
+
/**
* Element stored in a set.
*/
* in the result set.
*
* @param cls closure
- * @param element a result element, only valid if status is GNUNET_SET_STATUS_OK
- * @param status see enum GNUNET_SET_Status
+ * @param element a result element, only valid if status is #GNUNET_SET_STATUS_OK
+ * @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);
+/**
+ * Iterator for set elements.
+ *
+ * @param cls closure
+ * @param element the current element, NULL if all elements have been
+ * 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);
+
/**
* Called when another peer wants to do a set operation with the
- * local peer.
+ * local peer. If a listen error occurs, the @a request is NULL.
*
* @param cls closure
* @param other_peer the other peer
* @param context_msg message with application specific information from
* the other peer
- * @param request request from the other peer, use GNUNET_SET_accept
+ * @param request request from the other peer (never NULL), use GNUNET_SET_accept()
* to accept it, otherwise the request will be refused
- * Note that we don't use a return value here, as it is also
- * necessary to specify the set we want to do the operation with,
- * whith sometimes can be derived from the context message.
- * Also necessary to specify the timeout.
+ * Note that we can't just return value from the listen callback,
+ * as it is also necessary to specify the set we want to do the
+ * operation with, whith sometimes can be derived from the context
+ * message. It's necessary to specify the timeout.
*/
typedef void
(*GNUNET_SET_ListenCallback) (void *cls,
/**
* Add an element to the given set.
* After the element has been added (in the sense of being
- * transmitted to the set service), cont will be called.
- * Calls to add_element can be queued
+ * transmitted to the set service), @a cont will be called.
+ * Calls to #GNUNET_SET_add_element can be queued
*
* @param set set to add element to
* @param element element to add to the set
* @param cont continuation called after the element has been added
- * @param cont_cls closure for cont
+ * @param cont_cls closure for @a cont
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR if the
+ * set is invalid (e.g. the set service crashed)
*/
-void
+int
GNUNET_SET_add_element (struct GNUNET_SET_Handle *set,
const struct GNUNET_SET_Element *element,
GNUNET_SET_Continuation cont,
* @param set set to remove element from
* @param element element to remove from the set
* @param cont continuation called after the element has been removed
- * @param cont_cls closure for cont
+ * @param cont_cls closure for @a cont
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR if the
+ * set is invalid (e.g. the set service crashed)
*/
-void
+int
GNUNET_SET_remove_element (struct GNUNET_SET_Handle *set,
const struct GNUNET_SET_Element *element,
GNUNET_SET_Continuation cont,
/**
* Prepare a set operation to be evaluated with another peer.
* The evaluation will not start until the client provides
- * a local set with GNUNET_SET_commit.
+ * a local set with GNUNET_SET_commit().
*
* @param other_peer peer with the other set
* @param app_id hash for the application using the set
* fail due to hash collisions, using a different salt for each operation
* makes it harder for an attacker to exploit this
* @param result_mode specified how results will be returned,
- * see 'GNUNET_SET_ResultMode'.
+ * see `enum GNUNET_SET_ResultMode`.
* @param result_cb called on error or success
- * @param result_cls closure for result_cb
+ * @param result_cls closure for @a result_cb
* @return a handle to cancel the operation
*/
struct GNUNET_SET_OperationHandle *
/**
- * Wait for set operation requests for the given application id
- *
+ * Wait for set operation requests for the given application ID.
+ * If the connection to the set service is lost, the listener is
+ * re-created transparently with exponential backoff.
+ *
* @param cfg configuration to use for connecting to
* the set service
* @param operation operation we want to listen for
/**
* Cancel the given listen operation.
+ * After calling cancel, the listen callback for this listen handle
+ * will not be called again.
*
* @param lh handle for the listen operation
*/
/**
- * Accept a request we got via GNUNET_SET_listen. Must be called during
- * GNUNET_SET_listen, as the 'struct GNUNET_SET_Request' becomes invalid
+ * Accept a request we got via GNUNET_SET_listen(). Must be called during
+ * GNUNET_SET_listen(), as the `struct GNUNET_SET_Request` becomes invalid
* afterwards.
- * Call GNUNET_SET_commit to provide the local set to use for the operation,
- * and to begin the exchange with the remote peer.
+ * Call GNUNET_SET_commit() to provide the local set to use for the operation,
+ * and to begin the exchange with the remote peer.
*
* @param request request to accept
* @param result_mode specified how results will be returned,
- * see 'GNUNET_SET_ResultMode'.
+ * see `enum GNUNET_SET_ResultMode`.
* @param result_cb callback for the results
- * @param result_cls closure for result_cb
+ * @param result_cls closure for @a result_cb
* @return a handle to cancel the operation
*/
struct GNUNET_SET_OperationHandle *
* set information and call the result callback with the
* result information.
*
- * @param oh handle to the set operation
+ * @param oh handle to the set operation
* @param set the set to use for the operation
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR if the
+ * set is invalid (e.g. the set service crashed)
*/
-void
+int
GNUNET_SET_commit (struct GNUNET_SET_OperationHandle *oh,
struct GNUNET_SET_Handle *set);
GNUNET_SET_operation_cancel (struct GNUNET_SET_OperationHandle *oh);
+/**
+ * Iterate over all elements in the given set.
+ * Note that this operation involves transferring every element of the set
+ * from the service to the client, and is thus costly.
+ * Only one iteration per set may be active at the same time.
+ *
+ * @param set the set to iterate over
+ * @param iter the iterator to call for each element
+ * @param cls closure for 'iter'
+ * @return GNUNET_YES if the iteration started successfuly,
+ * GNUNET_SYSERR if the set is invalid (e.g. the server crashed, disconnected)
+ */
+int
+GNUNET_SET_iterate (struct GNUNET_SET_Handle *set, GNUNET_SET_ElementIterator iter, void *cls);
+
+
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
projects / oweals / gnunet.git / blobdiff