2 This file is part of GNUnet
3 (C) 2012 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 2, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file include/gnunet_consensus_service.h
24 * @author Florian Dold
27 #ifndef GNUNET_CONSENSUS_SERVICE_H
28 #define GNUNET_CONSENSUS_SERVICE_H
33 #if 0 /* keep Emacsens' auto-indent happy */
39 #include "gnunet_common.h"
40 #include "gnunet_time_lib.h"
41 #include "gnunet_configuration_lib.h"
45 * An element of the consensus set.
47 struct GNUNET_CONSENSUS_Element
50 * The actual data of the element.
55 * Size of the element's data.
60 * Application specific element type
67 * Called when a new element was received from another peer, or an error occured.
69 * May deliver duplicate values.
71 * Elements given to a consensus operation by the local peer are NOT given
75 * @param element new element, NULL on error
76 * @return GNUNET_OK if the valid is well-formed and should be added to the consensus,
77 * GNUNET_SYSERR if the element should be ignored and not be propagated
79 typedef int (*GNUNET_CONSENSUS_NewElementCallback) (void *cls,
80 struct GNUNET_CONSENSUS_Element *element);
85 * Opaque handle for the consensus service.
87 struct GNUNET_CONSENSUS_Handle;
91 * Create a consensus session.
92 * The set being reconciled is initially empty. Only reconcile with other peers
93 * after GNUNET_CONSENSUS_reconcile has been called.
97 * @param peers array of peers participating in this consensus session
98 * Inclusion of the local peer is optional.
99 * @param session_id session identifier
100 * Allows a group of peers to have more than consensus session.
101 * @param new_element_cb callback, called when a new element is added to the set by
103 * @param new_element_cls closure for new_element
104 * @return handle to use, NULL on error
106 struct GNUNET_CONSENSUS_Handle *
107 GNUNET_CONSENSUS_create (const struct GNUNET_CONFIGURATION_Handle *cfg,
108 unsigned int num_peers,
109 const struct GNUNET_PeerIdentity *peers,
110 const struct GNUNET_HashCode *session_id,
111 GNUNET_CONSENSUS_NewElementCallback new_element_cb,
112 void *new_element_cls);
116 * Called when an insertion (transmission to consensus service,
117 * which does not imply fully consensus on this element with
118 * all other peers) was successful.
121 * @param success GNUNET_OK on success, GNUNET_SYSERR if
122 * the insertion and thus the consensus failed for good
124 typedef void (*GNUNET_CONSENSUS_InsertDoneCallback) (void *cls,
129 * Insert an element in the set being reconsiled. Only transmit changes to
130 * other peers if "GNUNET_CONSENSUS_begin" has been called.
131 * Must not be called after "GNUNET_CONSENSUS_conclude".
133 * @param consensus handle for the consensus session
134 * @param element the element to be inserted
135 * @param idc function called when we are done with this element and it
136 * is thus allowed to call GNUNET_CONSENSUS_insert again
137 * @param idc_cls closure for 'idc'
140 GNUNET_CONSENSUS_insert (struct GNUNET_CONSENSUS_Handle *consensus,
141 const struct GNUNET_CONSENSUS_Element *element,
142 GNUNET_CONSENSUS_InsertDoneCallback idc,
147 * Begin reconciling elements with other peers.
148 * May not be called if an insert operation has not yet finished.
150 * @param consensus handle for the consensus session
153 GNUNET_CONSENSUS_begin (struct GNUNET_CONSENSUS_Handle *consensus);
157 struct GNUNET_CONSENSUS_DeltaRequest;
160 * We are finished inserting new elements into the consensus;
161 * try to conclude the consensus within a given time window.
163 * @param consensus consensus session
164 * @param timeout timeout after which the conculde callback
166 * @param conclude called when the conclusion was successful
167 * @param conclude_cls closure for the conclude callback
169 struct GNUNET_CONSENSUS_DeltaRequest *
170 GNUNET_CONSENSUS_get_delta (struct GNUNET_CONSENSUS_Handle *consensus,
172 GNUNET_CONSENSUS_NewElementCallback remove_element_cb,
173 void *remove_element_cb_cls);
177 GNUNET_CONSENSUS_get_delta_cancel (struct GNUNET_CONSENSUS_DeltaRequest *dr);
180 struct GNUNET_CONSENSUS_Group
182 uint32_t group_id; /* offset into groups? */
183 unsigned int num_members;
184 uint64_t total_elements_in_group;
185 const struct GNUNET_PeerIdentity **members;
190 * Called when a conclusion was successful.
193 * @param num_peers_in_consensus
194 * @param peers_in_consensus
196 typedef void (*GNUNET_CONSENSUS_NewConcludeCallback) (void *cls,
197 unsigned int consensus_group_count,
198 const struct GNUNET_CONSENSUS_Group *groups);
202 * Called when a conclusion was successful.
205 * @param num_peers_in_consensus
206 * @param peers_in_consensus
208 typedef void (*GNUNET_CONSENSUS_ConcludeCallback) (void *cls,
209 unsigned int num_peers_in_consensus,
210 const struct GNUNET_PeerIdentity *peers_in_consensus);
214 * We are finished inserting new elements into the consensus;
215 * try to conclude the consensus within a given time window.
217 * @param consensus consensus session
218 * @param timeout timeout after which the conculde callback
220 * @param conclude called when the conclusion was successful
221 * @param conclude_cls closure for the conclude callback
224 GNUNET_CONSENSUS_conclude (struct GNUNET_CONSENSUS_Handle *consensus,
225 struct GNUNET_TIME_Relative timeout,
226 GNUNET_CONSENSUS_ConcludeCallback conclude,
231 * Destroy a consensus handle (free all state associated with
232 * it, no longer call any of the callbacks).
234 * @param consensus handle to destroy
237 GNUNET_CONSENSUS_destroy (struct GNUNET_CONSENSUS_Handle *consensus);
240 #if 0 /* keep Emacsens' auto-indent happy */