2 This file is part of GNUnet.
3 Copyright (C) 2012, 2016 GNUnet e.V.
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 3, 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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file consensus/consensus_api.c
24 * @author Florian Dold
27 #include "gnunet_util_lib.h"
28 #include "gnunet_protocols.h"
29 #include "gnunet_client_lib.h"
30 #include "gnunet_consensus_service.h"
31 #include "consensus.h"
34 #define LOG(kind,...) GNUNET_log_from (kind, "consensus-api",__VA_ARGS__)
38 * Handle for the service.
40 struct GNUNET_CONSENSUS_Handle
43 * Configuration to use.
45 const struct GNUNET_CONFIGURATION_Handle *cfg;
48 * Callback for new elements. Not called for elements added locally.
50 GNUNET_CONSENSUS_ElementCallback new_element_cb;
53 * Closure for @e new_element_cb
55 void *new_element_cls;
58 * The (local) session identifier for the consensus session.
60 struct GNUNET_HashCode session_id;
63 * #GNUNET_YES iff the join message has been sent to the service.
68 * Called when the conclude operation finishes or fails.
70 GNUNET_CONSENSUS_ConcludeCallback conclude_cb;
73 * Closure for the @e conclude_cb callback.
78 * Deadline for the conclude operation.
80 struct GNUNET_TIME_Absolute conclude_deadline;
83 * Message queue for the client.
85 struct GNUNET_MQ_Handle *mq;
90 * FIXME: this should not bee necessary when the API
91 * issue has been fixed
95 GNUNET_CONSENSUS_InsertDoneCallback idc;
101 * Called when the server has sent is a new element
103 * @param cls consensus handle
104 * @param msg element message
107 check_new_element (void *cls,
108 const struct GNUNET_CONSENSUS_ElementMessage *msg)
110 /* any size is fine, elements are variable-size */
116 * Called when the server has sent is a new element
118 * @param cls consensus handle
119 * @param msg element message
122 handle_new_element (void *cls,
123 const struct GNUNET_CONSENSUS_ElementMessage *msg)
125 struct GNUNET_CONSENSUS_Handle *consensus = cls;
126 struct GNUNET_SET_Element element;
128 LOG (GNUNET_ERROR_TYPE_DEBUG,
129 "received new element\n");
130 element.element_type = msg->element_type;
131 element.size = ntohs (msg->header.size) - sizeof (struct GNUNET_CONSENSUS_ElementMessage);
132 element.data = &msg[1];
133 consensus->new_element_cb (consensus->new_element_cls,
139 * Called when the server has announced
140 * that the conclusion is over.
142 * @param cls consensus handle
143 * @param msg conclude done message
146 handle_conclude_done (void *cls,
147 const struct GNUNET_MessageHeader *msg)
149 struct GNUNET_CONSENSUS_Handle *consensus = cls;
150 GNUNET_CONSENSUS_ConcludeCallback cc;
152 GNUNET_MQ_destroy (consensus->mq);
153 consensus->mq = NULL;
154 GNUNET_assert (NULL != (cc = consensus->conclude_cb));
155 consensus->conclude_cb = NULL;
156 cc (consensus->conclude_cls);
161 * Generic error handler, called with the appropriate
162 * error code and the same closure specified at the creation of
164 * Not every message queue implementation supports an error handler.
166 * @param cls closure, same closure as for the message handlers
167 * @param error error code
170 mq_error_handler (void *cls,
171 enum GNUNET_MQ_Error error)
173 LOG (GNUNET_ERROR_TYPE_WARNING,
174 "consensus service disconnected us\n");
179 * Create a consensus session.
181 * @param cfg configuration to use for connecting to the consensus service
182 * @param num_peers number of peers in the peers array
183 * @param peers array of peers participating in this consensus session
184 * Inclusion of the local peer is optional.
185 * @param session_id session identifier
186 * Allows a group of peers to have more than consensus session.
187 * @param start start time of the consensus, conclude should be called before
189 * @param deadline time when the consensus should have concluded
190 * @param new_element_cb callback, called when a new element is added to the set by
192 * @param new_element_cls closure for new_element
193 * @return handle to use, NULL on error
195 struct GNUNET_CONSENSUS_Handle *
196 GNUNET_CONSENSUS_create (const struct GNUNET_CONFIGURATION_Handle *cfg,
197 unsigned int num_peers,
198 const struct GNUNET_PeerIdentity *peers,
199 const struct GNUNET_HashCode *session_id,
200 struct GNUNET_TIME_Absolute start,
201 struct GNUNET_TIME_Absolute deadline,
202 GNUNET_CONSENSUS_ElementCallback new_element_cb,
203 void *new_element_cls)
205 GNUNET_MQ_hd_var_size (new_element,
206 GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_RECEIVED_ELEMENT,
207 struct GNUNET_CONSENSUS_ElementMessage);
208 GNUNET_MQ_hd_fixed_size (conclude_done,
209 GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_CONCLUDE_DONE,
210 struct GNUNET_MessageHeader);
211 struct GNUNET_CONSENSUS_Handle *consensus
212 = GNUNET_new (struct GNUNET_CONSENSUS_Handle);
213 struct GNUNET_MQ_MessageHandler mq_handlers[] = {
214 make_new_element_handler (consensus),
215 make_conclude_done_handler (consensus),
216 GNUNET_MQ_handler_end ()
218 struct GNUNET_CONSENSUS_JoinMessage *join_msg;
219 struct GNUNET_MQ_Envelope *ev;
221 consensus->cfg = cfg;
222 consensus->new_element_cb = new_element_cb;
223 consensus->new_element_cls = new_element_cls;
224 consensus->session_id = *session_id;
225 consensus->mq = GNUNET_CLIENT_connecT (cfg,
230 if (NULL == consensus->mq)
232 GNUNET_free (consensus);
235 ev = GNUNET_MQ_msg_extra (join_msg,
236 (num_peers * sizeof (struct GNUNET_PeerIdentity)),
237 GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_JOIN);
239 join_msg->session_id = consensus->session_id;
240 join_msg->start = GNUNET_TIME_absolute_hton (start);
241 join_msg->deadline = GNUNET_TIME_absolute_hton (deadline);
242 join_msg->num_peers = htonl (num_peers);
243 GNUNET_memcpy(&join_msg[1],
245 num_peers * sizeof (struct GNUNET_PeerIdentity));
247 GNUNET_MQ_send (consensus->mq, ev);
253 idc_adapter (void *cls)
255 struct InsertDoneInfo *i = cls;
256 i->idc (i->cls, GNUNET_OK);
261 * Insert an element in the set being reconsiled. Must not be called after
262 * "GNUNET_CONSENSUS_conclude".
264 * @param consensus handle for the consensus session
265 * @param element the element to be inserted
266 * @param idc function called when we are done with this element and it
267 * is thus allowed to call GNUNET_CONSENSUS_insert again
268 * @param idc_cls closure for 'idc'
271 GNUNET_CONSENSUS_insert (struct GNUNET_CONSENSUS_Handle *consensus,
272 const struct GNUNET_SET_Element *element,
273 GNUNET_CONSENSUS_InsertDoneCallback idc,
276 struct GNUNET_CONSENSUS_ElementMessage *element_msg;
277 struct GNUNET_MQ_Envelope *ev;
278 struct InsertDoneInfo *i;
280 LOG (GNUNET_ERROR_TYPE_DEBUG, "inserting, size=%llu\n", element->size);
282 ev = GNUNET_MQ_msg_extra (element_msg, element->size,
283 GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_INSERT);
285 GNUNET_memcpy (&element_msg[1], element->data, element->size);
289 i = GNUNET_new (struct InsertDoneInfo);
292 GNUNET_MQ_notify_sent (ev, idc_adapter, i);
294 GNUNET_MQ_send (consensus->mq, ev);
299 * We are done with inserting new elements into the consensus;
300 * try to conclude the consensus within a given time window.
301 * After conclude has been called, no further elements may be
302 * inserted by the client.
304 * @param consensus consensus session
305 * @param deadline deadline after which the conculde callback
307 * @param conclude called when the conclusion was successful
308 * @param conclude_cls closure for the conclude callback
311 GNUNET_CONSENSUS_conclude (struct GNUNET_CONSENSUS_Handle *consensus,
312 GNUNET_CONSENSUS_ConcludeCallback conclude,
315 struct GNUNET_MQ_Envelope *ev;
317 GNUNET_assert (NULL != conclude);
318 GNUNET_assert (NULL == consensus->conclude_cb);
320 consensus->conclude_cls = conclude_cls;
321 consensus->conclude_cb = conclude;
323 ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_CONSENSUS_CLIENT_CONCLUDE);
324 GNUNET_MQ_send (consensus->mq, ev);
329 * Destroy a consensus handle (free all state associated with
330 * it, no longer call any of the callbacks).
332 * @param consensus handle to destroy
335 GNUNET_CONSENSUS_destroy (struct GNUNET_CONSENSUS_Handle *consensus)
337 if (NULL != consensus->mq)
339 GNUNET_MQ_destroy (consensus->mq);
340 consensus->mq = NULL;
342 GNUNET_free (consensus);
345 /* end of consensus_api.c */