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 = (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 * Current TTL for the request.
97 struct GNUNET_TIME_Absolute ttl;
100 * When did we start with the request.
102 struct GNUNET_TIME_Absolute start_time;
105 * Desired anonymity level.
107 uint32_t anonymity_level;
110 * Priority that this request (still) has for us.
115 * Priority that this request (originally) had for us.
117 uint32_t original_priority;
120 * Options for the request.
122 enum GSF_PendingRequestOptions options;
125 * Type of the requested block.
127 enum GNUNET_BLOCK_Type type;
130 * Number of results we have found for this request so far.
132 unsigned int results_found;
135 * Is the 'target' value set to a valid peer identity?
143 * Handle a reply to a pending request. Also called if a request
144 * expires (then with data == NULL). The handler may be called
145 * many times (depending on the request type), but will not be
146 * called during or after a call to GSF_pending_request_cancel
147 * and will also not be called anymore after a call signalling
150 * @param cls user-specified closure
151 * @param pr handle to the original pending request
152 * @param expiration when does 'data' expire?
153 * @param data response data, NULL on request expiration
154 * @param data_len number of bytes in data
155 * @param more GNUNET_YES if the request remains active (may call
156 * this function again), GNUNET_NO if the request is
157 * finished (client must not call GSF_pending_request_cancel_)
159 typedef void (*GSF_PendingRequestReplyHandler)(void *cls,
160 struct GSF_PendingRequest *pr,
161 struct GNUNET_TIME_Absolute expiration,
168 * Create a new pending request.
170 * @param options request options
171 * @param type type of the block that is being requested
172 * @param query key for the lookup
173 * @param namespace namespace to lookup, NULL for no namespace
174 * @param target preferred target for the request, NULL for none
175 * @param bf_data raw data for bloom filter for known replies, can be NULL
176 * @param bf_size number of bytes in bf_data
177 * @param mingle mingle value for bf
178 * @param anonymity_level desired anonymity level
179 * @param priority maximum outgoing cummulative request priority to use
180 * @param ttl current time-to-live for the request
181 * @param replies_seen hash codes of known local replies
182 * @param replies_seen_count size of the 'replies_seen' array
183 * @param rh handle to call when we get a reply
184 * @param rh_cls closure for rh
185 * @return handle for the new pending request
187 struct GSF_PendingRequest *
188 GSF_pending_request_create_ (enum GSF_PendingRequestOptions options,
189 enum GNUNET_BLOCK_Type type,
190 const GNUNET_HashCode *query,
191 const GNUNET_HashCode *namespace,
192 const struct GNUNET_PeerIdentity *target,
196 uint32_t anonymity_level,
199 const GNUNET_HashCode *replies_seen,
200 unsigned int replies_seen_count,
201 GSF_PendingRequestReplyHandler rh,
206 * Update a given pending request with additional replies
207 * that have been seen.
209 * @param pr request to update
210 * @param replies_seen hash codes of replies that we've seen
211 * @param replies_seen_count size of the replies_seen array
214 GSF_pending_request_update_ (struct GSF_PendingRequest *pr,
215 const GNUNET_HashCode *replies_seen,
216 unsigned int replies_seen_count);
220 * Obtain the public data associated with a pending request
222 * @param pr pending request
223 * @return associated public data
225 struct GSF_PendingRequestData *
226 GSF_pending_request_get_data_ (struct GSF_PendingRequest *pr);
230 * Generate the message corresponding to the given pending request for
231 * transmission to other peers (or at least determine its size).
233 * @param pr request to generate the message for
234 * @param do_route are we routing the reply
235 * @param buf_size number of bytes available in buf
236 * @param buf where to copy the message (can be NULL)
237 * @return number of bytes needed (if buf_size too small) or used
240 GSF_pending_request_get_message_ (struct GSF_PendingRequest *pr,
247 * Explicitly cancel a pending request.
249 * @param pr request to cancel
252 GSF_pending_request_cancel_ (struct GSF_PendingRequest *pr);
256 * Signature of function called on each request.
257 * (Note: 'subtype' of GNUNET_CONTAINER_HashMapIterator).
260 * @param key query for the request
261 * @param pr handle to the pending request
262 * @return GNUNET_YES to continue to iterate
264 typedef int (*GSF_PendingRequestIterator)(void *cls,
265 const GNUNET_HashCode *key,
266 struct GSF_PendingRequest *pr);
270 * Iterate over all pending requests.
272 * @param it function to call for each request
273 * @param cls closure for it
276 GSF_iterate_pending_requests_ (GSF_PendingRequestIterator it,
281 * Handle P2P "CONTENT" message. Checks that the message is
282 * well-formed and then checks if there are any pending requests for
283 * this content and possibly passes it on (to local clients or other
284 * peers). Does NOT perform migration (content caching at this peer).
286 * @param cp the other peer involved (sender or receiver, NULL
287 * for loopback messages where we are both sender and receiver)
288 * @param message the actual message
289 * @return GNUNET_OK if the message was well-formed,
290 * GNUNET_SYSERR if the message was malformed (close connection,
291 * do not cache under any circumstances)
294 GSF_handle_p2p_content_ (struct GSF_ConnectedPeer *cp,
295 const struct GNUNET_MessageHeader *message);
299 * Iterator called on each result obtained for a DHT
300 * operation that expects a reply
302 * @param cls closure, the 'struct GSF_PendingRequest *'.
303 * @param exp when will this value expire
304 * @param key key of the result
305 * @param get_path NULL-terminated array of pointers
306 * to the peers on reverse GET path (or NULL if not recorded)
307 * @param put_path NULL-terminated array of pointers
308 * to the peers on the PUT path (or NULL if not recorded)
309 * @param type type of the result
310 * @param size number of bytes in data
311 * @param data pointer to the result data
314 GSF_handle_dht_reply_ (void *cls,
315 struct GNUNET_TIME_Absolute exp,
316 const GNUNET_HashCode * key,
317 const struct GNUNET_PeerIdentity * const *get_path,
318 const struct GNUNET_PeerIdentity * const *put_path,
319 enum GNUNET_BLOCK_Type type,
325 * Setup the subsystem.
327 * @param cfg configuration to use
330 GSF_pending_request_init_ (struct GNUNET_CONFIGURATION_Handle *cfg);
334 * Shutdown the subsystem.
337 GSF_pending_request_done_ (void);
341 /* end of gnunet-service-fs_pr.h */