2 This file is part of GNUnet.
3 (C) 2009, 2010, 2011 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.
22 * @file fs/gnunet-service-fs_pr.h
23 * @brief API to handle pending requests
24 * @author Christian Grothoff
26 #ifndef GNUNET_SERVICE_FS_PR_H
27 #define GNUNET_SERVICE_FS_PR_H
29 #include "gnunet-service-fs.h"
33 * Options for pending requests (bits to be ORed).
35 enum GSF_PendingRequestOptions
38 * Request must only be processed locally.
40 GSF_PRO_LOCAL_ONLY = 1,
43 * Request must only be forwarded (no routing)
45 GSF_PRO_FORWARD_ONLY = 2,
48 * Request persists indefinitely (no expiration).
50 GSF_PRO_REQUEST_EXPIRES = 4,
53 * Request is allowed to refresh bloomfilter and change mingle value.
55 GSF_PRO_BLOOMFILTER_FULL_REFRESH = 8,
58 * Request priority is allowed to be exceeded.
60 GSF_PRO_PRIORITY_UNLIMITED = 16,
63 * Option mask for typical local requests.
65 GSF_PRO_LOCAL_REQUEST =
66 (GSF_PRO_BLOOMFILTER_FULL_REFRESH | GSF_PRO_PRIORITY_UNLIMITED)
71 * Public data (in the sense of not encapsulated within
72 * 'gnunet-service-fs_pr', not in the sense of network-wide
73 * known) associated with each pending request.
75 struct GSF_PendingRequestData
79 * Primary query hash for this request.
81 GNUNET_HashCode query;
84 * Namespace to query, only set if the type is SBLOCK.
86 GNUNET_HashCode namespace;
89 * Identity of a peer hosting the content, only set if
90 * 'has_target' is GNUNET_YES.
92 struct GNUNET_PeerIdentity target;
95 * Fields for the plan module to track a DLL with the request.
97 struct GSF_RequestPlanReference *rpr_head;
100 * Fields for the plan module to track a DLL with the request.
102 struct GSF_RequestPlanReference *rpr_tail;
105 * Current TTL for the request.
107 struct GNUNET_TIME_Absolute ttl;
110 * When did we start with the request.
112 struct GNUNET_TIME_Absolute start_time;
115 * Desired anonymity level.
117 uint32_t anonymity_level;
120 * Priority that this request (still) has for us.
125 * Priority that this request (originally) had for us.
127 uint32_t original_priority;
130 * Options for the request.
132 enum GSF_PendingRequestOptions options;
135 * Type of the requested block.
137 enum GNUNET_BLOCK_Type type;
140 * Number of results we have found for this request so far.
142 unsigned int results_found;
145 * Is the 'target' value set to a valid peer identity?
153 * Handle a reply to a pending request. Also called if a request
154 * expires (then with data == NULL). The handler may be called
155 * many times (depending on the request type), but will not be
156 * called during or after a call to GSF_pending_request_cancel
157 * and will also not be called anymore after a call signalling
160 * @param cls user-specified closure
161 * @param eval evaluation of the result
162 * @param pr handle to the original pending request
163 * @param reply_anonymity_level anonymity level for the reply, UINT32_MAX for "unknown"
164 * @param expiration when does 'data' expire?
165 * @param type type of the block
166 * @param data response data, NULL on request expiration
167 * @param data_len number of bytes in data
169 typedef void (*GSF_PendingRequestReplyHandler) (void *cls,
171 GNUNET_BLOCK_EvaluationResult
173 struct GSF_PendingRequest * pr,
174 uint32_t reply_anonymity_level,
175 struct GNUNET_TIME_Absolute
177 enum GNUNET_BLOCK_Type type,
183 * Create a new pending request.
185 * @param options request options
186 * @param type type of the block that is being requested
187 * @param query key for the lookup
188 * @param namespace namespace to lookup, NULL for no namespace
189 * @param target preferred target for the request, NULL for none
190 * @param bf_data raw data for bloom filter for known replies, can be NULL
191 * @param bf_size number of bytes in bf_data
192 * @param mingle mingle value for bf
193 * @param anonymity_level desired anonymity level
194 * @param priority maximum outgoing cummulative request priority to use
195 * @param ttl current time-to-live for the request
196 * @param sender_pid peer ID to use for the sender when forwarding, 0 for none;
197 * reference counter is taken over by this function
198 * @param replies_seen hash codes of known local replies
199 * @param replies_seen_count size of the 'replies_seen' array
200 * @param rh handle to call when we get a reply
201 * @param rh_cls closure for rh
202 * @return handle for the new pending request
204 struct GSF_PendingRequest *
205 GSF_pending_request_create_ (enum GSF_PendingRequestOptions options,
206 enum GNUNET_BLOCK_Type type,
207 const GNUNET_HashCode * query,
208 const GNUNET_HashCode * namespace,
209 const struct GNUNET_PeerIdentity *target,
210 const char *bf_data, size_t bf_size,
211 uint32_t mingle, uint32_t anonymity_level,
212 uint32_t priority, int32_t ttl,
213 GNUNET_PEER_Id sender_pid,
214 const GNUNET_HashCode * replies_seen,
215 unsigned int replies_seen_count,
216 GSF_PendingRequestReplyHandler rh, void *rh_cls);
220 * Update a given pending request with additional replies
221 * that have been seen.
223 * @param pr request to update
224 * @param replies_seen hash codes of replies that we've seen
225 * @param replies_seen_count size of the replies_seen array
228 GSF_pending_request_update_ (struct GSF_PendingRequest *pr,
229 const GNUNET_HashCode * replies_seen,
230 unsigned int replies_seen_count);
234 * Obtain the public data associated with a pending request
236 * @param pr pending request
237 * @return associated public data
239 struct GSF_PendingRequestData *
240 GSF_pending_request_get_data_ (struct GSF_PendingRequest *pr);
244 * Test if two pending requests are compatible (would generate
245 * the same query modulo filters and should thus be processed
248 * @param pra a pending request
249 * @param prb another pending request
250 * @return GNUNET_OK if the requests are compatible
253 GSF_pending_request_is_compatible_ (struct GSF_PendingRequest *pra,
254 struct GSF_PendingRequest *prb);
258 * Generate the message corresponding to the given pending request for
259 * transmission to other peers (or at least determine its size).
261 * @param pr request to generate the message for
262 * @param buf_size number of bytes available in buf
263 * @param buf where to copy the message (can be NULL)
264 * @return number of bytes needed (if buf_size too small) or used
267 GSF_pending_request_get_message_ (struct GSF_PendingRequest *pr,
268 size_t buf_size, void *buf);
272 * Explicitly cancel a pending request.
274 * @param pr request to cancel
275 * @param full_cleanup fully purge the request
278 GSF_pending_request_cancel_ (struct GSF_PendingRequest *pr, int full_cleanup);
282 * Signature of function called on each request.
283 * (Note: 'subtype' of GNUNET_CONTAINER_HashMapIterator).
286 * @param key query for the request
287 * @param pr handle to the pending request
288 * @return GNUNET_YES to continue to iterate
290 typedef int (*GSF_PendingRequestIterator) (void *cls,
291 const GNUNET_HashCode * key,
292 struct GSF_PendingRequest * pr);
296 * Iterate over all pending requests.
298 * @param it function to call for each request
299 * @param cls closure for it
302 GSF_iterate_pending_requests_ (GSF_PendingRequestIterator it, void *cls);
306 * Handle P2P "CONTENT" message. Checks that the message is
307 * well-formed and then checks if there are any pending requests for
308 * this content and possibly passes it on (to local clients or other
309 * peers). Does NOT perform migration (content caching at this peer).
311 * @param cp the other peer involved (sender or receiver, NULL
312 * for loopback messages where we are both sender and receiver)
313 * @param message the actual message
314 * @return GNUNET_OK if the message was well-formed,
315 * GNUNET_SYSERR if the message was malformed (close connection,
316 * do not cache under any circumstances)
319 GSF_handle_p2p_content_ (struct GSF_ConnectedPeer *cp,
320 const struct GNUNET_MessageHeader *message);
324 * Consider looking up the data in the DHT (anonymity-level permitting).
326 * @param pr the pending request to process
329 GSF_dht_lookup_ (struct GSF_PendingRequest *pr);
333 * Function to be called after we're done processing
334 * replies from the local lookup.
337 * @param pr the pending request we were processing
338 * @param result final datastore lookup result
340 typedef void (*GSF_LocalLookupContinuation) (void *cls,
341 struct GSF_PendingRequest * pr,
342 enum GNUNET_BLOCK_EvaluationResult
347 * Look up the request in the local datastore.
349 * @param pr the pending request to process
350 * @param cont function to call at the end
351 * @param cont_cls closure for cont
354 GSF_local_lookup_ (struct GSF_PendingRequest *pr,
355 GSF_LocalLookupContinuation cont, void *cont_cls);
359 * Setup the subsystem.
362 GSF_pending_request_init_ (void);
366 * Shutdown the subsystem.
369 GSF_pending_request_done_ (void);
373 /* end of gnunet-service-fs_pr.h */