/**
* Create a consensus session. The set being reconciled is initially
- * empty. Only reconcile with other peers after
- * GNUNET_CONSENSUS_reconcile has been called.
+ * empty.
*
* @param cfg
* @param num_peers
* @param session_id session identifier
* Allows a group of peers to have more than consensus session.
* @param new_element_cb callback, called when a new element is added to the set by
- * another peer
+ * another peer. Also called when an error occurs.
* @param new_element_cls closure for new_element
* @return handle to use, NULL on error
*/
/**
- * Called when an insertion (transmission to consensus service,
- * which does not imply fully consensus on this element with
- * all other peers) was successful.
- * May not call GNUNET_CONSENSUS_destroy; schedule a task to call
- * GNUNET_CONSENSUS_destroy instead.
+ * Called when an insertion (transmission to consensus service, which
+ * does not imply fully consensus on this element with all other
+ * peers) was successful. May not call GNUNET_CONSENSUS_destroy();
+ * schedule a task to call GNUNET_CONSENSUS_destroy() instead (if
+ * needed).
*
* @param cls
- * @param success GNUNET_OK on success, GNUNET_SYSERR if
+ * @param success #GNUNET_OK on success, #GNUNET_SYSERR if
* the insertion and thus the consensus failed for good
*/
typedef void (*GNUNET_CONSENSUS_InsertDoneCallback) (void *cls,
/**
* Insert an element in the set being reconsiled. Only transmit changes to
- * other peers if "GNUNET_CONSENSUS_begin" has been called.
- * Must not be called after "GNUNET_CONSENSUS_conclude".
- * May not call GNUNET_CONSENSUS_destroy; schedule a task to call
- * GNUNET_CONSENSUS_destroy instead.
+ * other peers if GNUNET_CONSENSUS_begin() has been called.
+ * Must not be called after GNUNET_CONSENSUS_conclude().
+ * May not call GNUNET_CONSENSUS_destroy(); schedule a task to call
+ * GNUNET_CONSENSUS_destroy() instead (if needed).
*
* @param consensus handle for the consensus session
* @param element the element to be inserted
* @param idc function called when we are done with this element and it
- * is thus allowed to call GNUNET_CONSENSUS_insert again
- * @param idc_cls closure for 'idc'
+ * is thus allowed to call GNUNET_CONSENSUS_insert() again
+ * @param idc_cls closure for @a idc
*/
void
GNUNET_CONSENSUS_insert (struct GNUNET_CONSENSUS_Handle *consensus,
* try to conclude the consensus within a given time window.
*
* @param consensus consensus session
- * @param timeout timeout after which the conculde callback
- * must be called
+ * @param deadline deadline after which the conculde callback
+ * whill be called
* @param conclude called when the conclusion was successful
* @param conclude_cls closure for the conclude callback
*/
void
GNUNET_CONSENSUS_conclude (struct GNUNET_CONSENSUS_Handle *consensus,
- struct GNUNET_TIME_Relative timeout,
+ struct GNUNET_TIME_Absolute deadline,
GNUNET_CONSENSUS_ConcludeCallback conclude,
void *conclude_cls);