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 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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
23 * @brief api for the set service
24 * @author Florian Dold
27 #include "gnunet_util_lib.h"
28 #include "gnunet_protocols.h"
29 #include "gnunet_client_lib.h"
30 #include "gnunet_set_service.h"
35 #define LOG(kind,...) GNUNET_log_from (kind, "set-api",__VA_ARGS__)
38 * Opaque handle to a set.
40 struct GNUNET_SET_Handle
42 struct GNUNET_CLIENT_Connection *client;
43 struct GNUNET_MQ_MessageQueue *mq;
44 unsigned int messages_since_ack;
48 * Opaque handle to a set operation request from another peer.
50 struct GNUNET_SET_Request
57 struct GNUNET_SET_OperationHandle
59 GNUNET_SET_ResultIterator result_cb;
61 struct GNUNET_SET_Handle *set;
63 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
68 * Opaque handle to a listen operation.
70 struct GNUNET_SET_ListenHandle
72 struct GNUNET_CLIENT_Connection *client;
73 struct GNUNET_MQ_MessageQueue* mq;
74 GNUNET_SET_ListenCallback listen_cb;
80 * Handle result message for a set operation.
83 * @param mh the message
86 handle_result (void *cls, const struct GNUNET_MessageHeader *mh)
88 struct ResultMessage *msg = (struct ResultMessage *) mh;
89 struct GNUNET_SET_Handle *set = cls;
90 struct GNUNET_SET_OperationHandle *oh;
91 struct GNUNET_SET_Element e;
93 if (set->messages_since_ack >= GNUNET_SET_ACK_WINDOW/2)
95 struct GNUNET_MQ_Message *mqm;
96 mqm = GNUNET_MQ_msg_raw (GNUNET_MESSAGE_TYPE_SET_ACK);
97 GNUNET_MQ_send (set->mq, mqm);
100 oh = GNUNET_MQ_assoc_get (set->mq, ntohl (msg->request_id));
101 GNUNET_break (NULL != oh);
102 if (GNUNET_SCHEDULER_NO_TASK != oh->timeout_task)
104 GNUNET_SCHEDULER_cancel (oh->timeout_task);
105 oh->timeout_task = GNUNET_SCHEDULER_NO_TASK;
107 if (htons (msg->result_status) != GNUNET_SET_STATUS_OK)
109 if (NULL != oh->result_cb)
110 oh->result_cb (oh->result_cls, NULL, htons (msg->result_status));
111 GNUNET_MQ_assoc_remove (set->mq, ntohl (msg->request_id));
116 e.size = ntohs (mh->size) - sizeof (struct ResultMessage);
117 e.type = msg->element_type;
118 if (NULL != oh->result_cb)
119 oh->result_cb (oh->result_cls, &e, htons (msg->result_status));
123 * Handle request message for a listen operation
125 * @param cls the listen handle
126 * @param mh the message
129 handle_request (void *cls, const struct GNUNET_MessageHeader *mh)
131 struct RequestMessage *msg = (struct RequestMessage *) mh;
132 struct GNUNET_SET_ListenHandle *lh = cls;
133 struct GNUNET_SET_Request *req;
135 req = GNUNET_new (struct GNUNET_SET_Request);
136 req->request_id = ntohl (msg->request_id);
137 lh->listen_cb (lh->listen_cls, &msg->peer_id, &mh[1], req);
138 if (GNUNET_NO == req->accepted)
144 * Create an empty set, supporting the specified operation.
146 * @param cfg configuration to use for connecting to the
148 * @param op operation supported by the set
149 * Note that the operation has to be specified
150 * beforehand, as certain set operations need to maintain
151 * data structures spefific to the operation
152 * @return a handle to the set
154 struct GNUNET_SET_Handle *
155 GNUNET_SET_create (struct GNUNET_CONFIGURATION_Handle *cfg,
156 enum GNUNET_SET_OperationType op)
158 struct GNUNET_SET_Handle *set;
159 struct GNUNET_MQ_Message *mqm;
160 struct SetCreateMessage *msg;
161 static const struct GNUNET_MQ_Handler mq_handlers[] = {
162 {handle_result, GNUNET_MESSAGE_TYPE_SET_RESULT},
163 GNUNET_MQ_HANDLERS_END
166 set = GNUNET_new (struct GNUNET_SET_Handle);
167 set->client = GNUNET_CLIENT_connect ("set", cfg);
168 GNUNET_assert (NULL != set->client);
169 set->mq = GNUNET_MQ_queue_for_connection_client (set->client, mq_handlers, set);
170 mqm = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_SET_CREATE);
171 msg->operation = htons (op);
172 GNUNET_MQ_send (set->mq, mqm);
178 * Add an element to the given set.
179 * After the element has been added (in the sense of being
180 * transmitted to the set service), cont will be called.
181 * Calls to add_element can be queued
183 * @param set set to add element to
184 * @param element element to add to the set
185 * @param cont continuation called after the element has been added
186 * @param cont_cls closure for cont
189 GNUNET_SET_add_element (struct GNUNET_SET_Handle *set,
190 const struct GNUNET_SET_Element *element,
191 GNUNET_SET_Continuation cont,
194 struct GNUNET_MQ_Message *mqm;
195 struct ElementMessage *msg;
197 mqm = GNUNET_MQ_msg_extra (msg, element->size, GNUNET_MESSAGE_TYPE_SET_ADD);
198 msg->element_type = element->type;
199 memcpy (&msg[1], element->data, element->size);
200 GNUNET_MQ_notify_sent (mqm, cont, cont_cls);
201 GNUNET_MQ_send (set->mq, mqm);
206 * Remove an element to the given set.
207 * After the element has been removed (in the sense of the
208 * request being transmitted to the set service), cont will be called.
209 * Calls to remove_element can be queued
211 * @param set set to remove element from
212 * @param element element to remove from the set
213 * @param cont continuation called after the element has been removed
214 * @param cont_cls closure for cont
217 GNUNET_SET_remove_element (struct GNUNET_SET_Handle *set,
218 const struct GNUNET_SET_Element *element,
219 GNUNET_SET_Continuation cont,
222 struct GNUNET_MQ_Message *mqm;
223 struct ElementMessage *msg;
225 mqm = GNUNET_MQ_msg_extra (msg, element->size, GNUNET_MESSAGE_TYPE_SET_REMOVE);
226 msg->element_type = element->type;
227 memcpy (&msg[1], element->data, element->size);
228 GNUNET_MQ_notify_sent (mqm, cont, cont_cls);
229 GNUNET_MQ_send (set->mq, mqm);
234 * Destroy the set handle, and free all associated resources.
237 GNUNET_SET_destroy (struct GNUNET_SET_Handle *set)
239 GNUNET_CLIENT_disconnect (set->client);
241 GNUNET_MQ_destroy (set->mq);
247 * Signature of the main function of a task.
250 * @param tc context information (why was this task triggered now)
253 operation_timeout_task (void *cls,
254 const struct GNUNET_SCHEDULER_TaskContext * tc)
256 struct GNUNET_SET_OperationHandle *oh = cls;
257 oh->timeout_task = GNUNET_SCHEDULER_NO_TASK;
258 if (NULL != oh->result_cb)
259 oh->result_cb (oh->result_cls, NULL, GNUNET_SET_STATUS_TIMEOUT);
260 oh->result_cb = NULL;
261 oh->result_cls = NULL;
262 GNUNET_SET_operation_cancel (oh);
267 * Evaluate a set operation with our set and the set of another peer.
269 * @param set set to use
270 * @param other_peer peer with the other set
271 * @param app_id hash for the application using the set
272 * @param context_msg additional information for the request
273 * @param result_cb called on error or success
274 * @param result_cls closure for result_cb
275 * @return a handle to cancel the operation
277 struct GNUNET_SET_OperationHandle *
278 GNUNET_SET_evaluate (struct GNUNET_SET_Handle *set,
279 const struct GNUNET_PeerIdentity *other_peer,
280 const struct GNUNET_HashCode *app_id,
281 const struct GNUNET_MessageHeader *context_msg,
282 struct GNUNET_TIME_Relative timeout,
283 enum GNUNET_SET_ResultMode result_mode,
284 GNUNET_SET_ResultIterator result_cb,
287 struct GNUNET_MQ_Message *mqm;
288 struct EvaluateMessage *msg;
289 struct GNUNET_SET_OperationHandle *oh;
291 oh = GNUNET_new (struct GNUNET_SET_OperationHandle);
292 oh->result_cb = result_cb;
293 oh->result_cls = result_cls;
296 mqm = GNUNET_MQ_msg_extra (msg, htons(context_msg->size), GNUNET_MESSAGE_TYPE_SET_EVALUATE);
297 msg->request_id = htonl (GNUNET_MQ_assoc_add (set->mq, mqm, oh));
298 msg->other_peer = *other_peer;
299 msg->app_id = *app_id;
300 memcpy (&msg[1], context_msg, htons (context_msg->size));
301 oh->timeout_task = GNUNET_SCHEDULER_add_delayed (timeout, operation_timeout_task, oh);
302 GNUNET_MQ_send (set->mq, mqm);
309 * Wait for set operation requests for the given application id
311 * @param cfg configuration to use for connecting to
313 * @param operation operation we want to listen for
314 * @param app_id id of the application that handles set operation requests
315 * @param listen_cb called for each incoming request matching the operation
317 * @param listen_cls handle for listen_cb
318 * @return a handle that can be used to cancel the listen operation
320 struct GNUNET_SET_ListenHandle *
321 GNUNET_SET_listen (struct GNUNET_CONFIGURATION_Handle *cfg,
322 enum GNUNET_SET_OperationType operation,
323 const struct GNUNET_HashCode *app_id,
324 GNUNET_SET_ListenCallback listen_cb,
327 struct GNUNET_SET_ListenHandle *lh;
328 struct GNUNET_MQ_Message *mqm;
329 struct ListenMessage *msg;
330 static const struct GNUNET_MQ_Handler mq_handlers[] = {
331 {handle_request, GNUNET_MESSAGE_TYPE_SET_REQUEST},
332 GNUNET_MQ_HANDLERS_END
335 lh = GNUNET_new (struct GNUNET_SET_ListenHandle);
336 lh->client = GNUNET_CLIENT_connect ("set", cfg);
337 lh->listen_cb = listen_cb;
338 lh->listen_cls = listen_cls;
339 GNUNET_assert (NULL != lh->client);
340 lh->mq = GNUNET_MQ_queue_for_connection_client (lh->client, mq_handlers, lh);
341 mqm = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_SET_LISTEN);
342 msg->operation = htons (operation);
343 msg->app_id = *app_id;
344 GNUNET_MQ_send (lh->mq, mqm);
351 * Cancel the given listen operation.
353 * @param lh handle for the listen operation
356 GNUNET_SET_listen_cancel (struct GNUNET_SET_ListenHandle *lh)
358 GNUNET_MQ_destroy (lh->mq);
360 GNUNET_CLIENT_disconnect (lh->client);
362 lh->listen_cb = NULL;
363 lh->listen_cls = NULL;
368 * Accept a request we got via GNUNET_SET_listen
370 * @param request request to accept
371 * @param set set used for the requested operation
372 * @param timeout timeout for the set operation
373 * @param result_cb callback for the results
374 * @param cls closure for result_cb
376 struct GNUNET_SET_OperationHandle *
377 GNUNET_SET_accept (struct GNUNET_SET_Request *request,
378 struct GNUNET_SET_Handle *set,
379 struct GNUNET_TIME_Relative timeout,
380 enum GNUNET_SET_ResultMode result_mode,
381 GNUNET_SET_ResultIterator result_cb,
384 struct GNUNET_MQ_Message *mqm;
385 struct AcceptMessage *msg;
386 struct GNUNET_SET_OperationHandle *oh;
388 /* don't accept a request twice! */
389 GNUNET_assert (GNUNET_NO == request->accepted);
390 request->accepted = GNUNET_YES;
392 oh = GNUNET_new (struct GNUNET_SET_OperationHandle);
393 oh->result_cb = result_cb;
394 oh->result_cls = result_cls;
397 mqm = GNUNET_MQ_msg (msg , GNUNET_MESSAGE_TYPE_SET_ACCEPT);
398 msg->request_id = htonl (request->request_id);
399 oh->timeout_task = GNUNET_SCHEDULER_add_delayed (timeout, operation_timeout_task, oh);
400 GNUNET_MQ_send (set->mq, mqm);
407 * Cancel the given set operation.
409 * @param op set operation to cancel
412 GNUNET_SET_operation_cancel (struct GNUNET_SET_OperationHandle *h)
414 struct GNUNET_MQ_Message *mqm;
415 struct GNUNET_SET_OperationHandle *h_assoc;
417 h_assoc = GNUNET_MQ_assoc_remove (h->set->mq, h->request_id);
418 GNUNET_assert (h_assoc == h);
419 mqm = GNUNET_MQ_msg_raw (GNUNET_MESSAGE_TYPE_SET_CANCEL);
420 GNUNET_MQ_send (h->set->mq, mqm);