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 * Desired anonymity level.
97 uint32_t anonymity_level;
100 * Priority that this request (still) has for us.
105 * Options for the request.
107 enum GSF_PendingRequestOptions options;
110 * Type of the requested block.
112 enum GNUNET_BLOCK_Type type;
115 * Is the 'target' value set to a valid peer identity?
123 * Handle a reply to a pending request. Also called if a request
124 * expires (then with data == NULL). The handler may be called
125 * many times (depending on the request type), but will not be
126 * called during or after a call to GSF_pending_request_cancel
127 * and will also not be called anymore after a call signalling
130 * @param cls user-specified closure
131 * @param pr handle to the original pending request
132 * @param data response data, NULL on request expiration
133 * @param data_len number of bytes in data
135 typedef void (*GSF_PendingRequestReplyHandler)(void *cls,
136 struct GSF_PendingRequest *pr,
142 * Create a new pending request.
144 * @param options request options
145 * @param type type of the block that is being requested
146 * @param query key for the lookup
147 * @param namespace namespace to lookup, NULL for no namespace
148 * @param target preferred target for the request, NULL for none
149 * @param bf bloom filter for known replies, can be NULL
150 * @param mingle mingle value for bf
151 * @param anonymity_level desired anonymity level
152 * @param priority maximum outgoing cummulative request priority to use
153 * @param replies_seen hash codes of known local replies
154 * @param replies_seen_count size of the 'replies_seen' array
155 * @param rh handle to call when we get a reply
156 * @param rh_cls closure for rh
157 * @return handle for the new pending request
159 struct GSF_PendingRequest *
160 GSF_pending_request_create_ (enum GSF_PendingRequestOptions options,
161 enum GNUNET_BLOCK_Type type,
162 const GNUNET_HashCode *query,
163 const GNUNET_HashCode *namespace,
164 const struct GNUNET_PeerIdentity *target,
165 const struct GNUNET_CONTAINER_BloomFilter *bf,
167 uint32_t anonymity_level,
169 const GNUNET_HashCode *replies_seen,
170 unsigned int replies_seen_count,
171 GSF_PendingRequestReplyHandler rh,
176 * Update a given pending request with additional replies
177 * that have been seen.
179 * @param pr request to update
180 * @param replies_seen hash codes of replies that we've seen
181 * @param replies_seen_count size of the replies_seen array
184 GSF_pending_request_update_ (struct GSF_PendingRequest *pr,
185 const GNUNET_HashCode *replies_seen,
186 unsigned int replies_seen_count);
190 * Generate the message corresponding to the given pending request for
191 * transmission to other peers (or at least determine its size).
193 * @param pr request to generate the message for
194 * @param do_route are we routing the reply
195 * @param buf_size number of bytes available in buf
196 * @param buf where to copy the message (can be NULL)
197 * @return number of bytes needed (if buf_size too small) or used
200 GSF_pending_request_get_message_ (struct GSF_PendingRequest *pr,
207 * Explicitly cancel a pending request.
209 * @param pr request to cancel
212 GSF_pending_request_cancel_ (struct GSF_PendingRequest *pr);
216 * Signature of function called on each request.
217 * (Note: 'subtype' of GNUNET_CONTAINER_HashMapIterator).
220 * @param key query for the request
221 * @param pr handle to the pending request
222 * @return GNUNET_YES to continue to iterate
224 typedef int (*GSF_PendingRequestIterator)(void *cls,
225 const GNUNET_HashCode *key,
226 struct GSF_PendingRequest *pr);
230 * Iterate over all pending requests.
232 * @param it function to call for each request
233 * @param cls closure for it
236 GSF_iterate_pending_requests_ (GSF_PendingRequestIterator it,
241 * Handle P2P "CONTENT" message. Checks that the message is
242 * well-formed and then checks if there are any pending requests for
243 * this content and possibly passes it on (to local clients or other
244 * peers). Does NOT perform migration (content caching at this peer).
246 * @param cp the other peer involved (sender or receiver, NULL
247 * for loopback messages where we are both sender and receiver)
248 * @param message the actual message
249 * @return GNUNET_OK if the message was well-formed,
250 * GNUNET_SYSERR if the message was malformed (close connection,
251 * do not cache under any circumstances)
254 GSF_handle_p2p_content_ (struct GSF_ConnectedPeer *cp,
255 const struct GNUNET_MessageHeader *message);
259 * Iterator called on each result obtained for a DHT
260 * operation that expects a reply
262 * @param cls closure, the 'struct GSF_PendingRequest *'.
263 * @param exp when will this value expire
264 * @param key key of the result
265 * @param get_path NULL-terminated array of pointers
266 * to the peers on reverse GET path (or NULL if not recorded)
267 * @param put_path NULL-terminated array of pointers
268 * to the peers on the PUT path (or NULL if not recorded)
269 * @param type type of the result
270 * @param size number of bytes in data
271 * @param data pointer to the result data
274 GSF_handle_dht_reply_ (void *cls,
275 struct GNUNET_TIME_Absolute exp,
276 const GNUNET_HashCode * key,
277 const struct GNUNET_PeerIdentity * const *get_path,
278 const struct GNUNET_PeerIdentity * const *put_path,
279 enum GNUNET_BLOCK_Type type,
285 * Setup the subsystem.
288 GSF_pending_request_init_ (void);
292 * Shutdown the subsystem.
295 GSF_pending_request_done_ (void);
299 /* end of gnunet-service-fs_pr.h */