/*
This file is part of GNUnet.
- (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2009, 2010, 2011 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
/**
* Primary query hash for this request.
*/
- GNUNET_HashCode query;
+ struct GNUNET_HashCode query;
/**
- * Namespace to query, only set if the type is SBLOCK.
+ * Identity of a peer hosting the content, otherwise NULl.
+ * Allocated after struct only if needed. Do not free!
*/
- GNUNET_HashCode namespace;
-
- /**
- * Identity of a peer hosting the content, only set if
- * 'has_target' is GNUNET_YES.
- */
- struct GNUNET_PeerIdentity target;
+ const struct GNUNET_PeerIdentity *target;
/**
* Fields for the plan module to track a DLL with the request.
*/
- struct GSF_RequestPlanReference *rpr_head;
+ struct GSF_PendingRequestPlanBijection *pr_head;
/**
* Fields for the plan module to track a DLL with the request.
*/
- struct GSF_RequestPlanReference *rpr_tail;
+ struct GSF_PendingRequestPlanBijection *pr_tail;
/**
* Current TTL for the request.
*/
uint32_t original_priority;
+ /**
+ * Counter for how often this request has been transmitted (estimate,
+ * because we might have the same request pending for multiple clients,
+ * and of course because a transmission may have failed at a lower
+ * layer).
+ */
+ uint32_t num_transmissions;
+
+ /**
+ * How much respect did we (in total) offer for this request so far (estimate,
+ * because we might have the same request pending for multiple clients,
+ * and of course because a transmission may have failed at a lower
+ * layer).
+ */
+ uint32_t respect_offered;
+
/**
* Options for the request.
*/
*/
unsigned int results_found;
- /**
- * Is the 'target' value set to a valid peer identity?
- */
- int has_target;
-
/**
* Has this request been started yet (local/p2p operations)? Or are
* we still constructing it?
* @param eval evaluation of the result
* @param pr handle to the original pending request
* @param reply_anonymity_level anonymity level for the reply, UINT32_MAX for "unknown"
- * @param expiration when does 'data' expire?
+ * @param expiration when does @a data expire?
+ * @param last_transmission the last time we've tried to get this block (FOREVER if unknown)
* @param type type of the block
* @param data response data, NULL on request expiration
- * @param data_len number of bytes in data
+ * @param data_len number of bytes in @a data
*/
-typedef void (*GSF_PendingRequestReplyHandler) (void *cls,
- enum
- GNUNET_BLOCK_EvaluationResult
- eval,
- struct GSF_PendingRequest * pr,
- uint32_t reply_anonymity_level,
- struct GNUNET_TIME_Absolute
- expiration,
- enum GNUNET_BLOCK_Type type,
- const void *data,
- size_t data_len);
+typedef void
+(*GSF_PendingRequestReplyHandler) (void *cls,
+ enum GNUNET_BLOCK_EvaluationResult eval,
+ struct GSF_PendingRequest *pr,
+ uint32_t reply_anonymity_level,
+ struct GNUNET_TIME_Absolute expiration,
+ struct GNUNET_TIME_Absolute last_transmission,
+ enum GNUNET_BLOCK_Type type,
+ const void *data,
+ size_t data_len);
/**
* @param options request options
* @param type type of the block that is being requested
* @param query key for the lookup
- * @param namespace namespace to lookup, NULL for no namespace
* @param target preferred target for the request, NULL for none
* @param bf_data raw data for bloom filter for known replies, can be NULL
* @param bf_size number of bytes in bf_data
struct GSF_PendingRequest *
GSF_pending_request_create_ (enum GSF_PendingRequestOptions options,
enum GNUNET_BLOCK_Type type,
- const GNUNET_HashCode * query,
- const GNUNET_HashCode * namespace,
+ const struct GNUNET_HashCode *query,
const struct GNUNET_PeerIdentity *target,
- const char *bf_data, size_t bf_size,
- uint32_t mingle, uint32_t anonymity_level,
- uint32_t priority, int32_t ttl,
+ const char *bf_data,
+ size_t bf_size,
+ uint32_t mingle,
+ uint32_t anonymity_level,
+ uint32_t priority,
+ int32_t ttl,
GNUNET_PEER_Id sender_pid,
GNUNET_PEER_Id origin_pid,
- const GNUNET_HashCode * replies_seen,
+ const struct GNUNET_HashCode *replies_seen,
unsigned int replies_seen_count,
- GSF_PendingRequestReplyHandler rh, void *rh_cls);
+ GSF_PendingRequestReplyHandler rh,
+ void *rh_cls);
/**
*
* @param pr request to update
* @param replies_seen hash codes of replies that we've seen
- * @param replies_seen_count size of the replies_seen array
+ * @param replies_seen_count size of the @a replies_seen array
*/
void
GSF_pending_request_update_ (struct GSF_PendingRequest *pr,
- const GNUNET_HashCode * replies_seen,
+ const struct GNUNET_HashCode *replies_seen,
unsigned int replies_seen_count);
GSF_pending_request_get_data_ (struct GSF_PendingRequest *pr);
+/**
+ * Check if the given request is still active.
+ *
+ * @param pr pending request
+ * @return #GNUNET_YES if the request is still active
+ */
+int
+GSF_pending_request_test_active_ (struct GSF_PendingRequest *pr);
+
+
/**
* Test if two pending requests are compatible (would generate
* the same query modulo filters and should thus be processed
*
* @param pra a pending request
* @param prb another pending request
- * @return GNUNET_OK if the requests are compatible
+ * @return #GNUNET_OK if the requests are compatible
*/
int
GSF_pending_request_is_compatible_ (struct GSF_PendingRequest *pra,
* transmission to other peers (or at least determine its size).
*
* @param pr request to generate the message for
- * @param buf_size number of bytes available in buf
+ * @param buf_size number of bytes available in @a buf
* @param buf where to copy the message (can be NULL)
- * @return number of bytes needed (if buf_size too small) or used
+ * @return number of bytes needed (if @a buf_size too small) or used
*/
size_t
GSF_pending_request_get_message_ (struct GSF_PendingRequest *pr,
- size_t buf_size, void *buf);
+ size_t buf_size,
+ void *buf);
/**
* @param full_cleanup fully purge the request
*/
void
-GSF_pending_request_cancel_ (struct GSF_PendingRequest *pr, int full_cleanup);
+GSF_pending_request_cancel_ (struct GSF_PendingRequest *pr,
+ int full_cleanup);
/**
* @param cls closure
* @param key query for the request
* @param pr handle to the pending request
- * @return GNUNET_YES to continue to iterate
+ * @return #GNUNET_YES to continue to iterate
*/
-typedef int (*GSF_PendingRequestIterator) (void *cls,
- const GNUNET_HashCode * key,
- struct GSF_PendingRequest * pr);
+typedef int
+(*GSF_PendingRequestIterator) (void *cls,
+ const struct GNUNET_HashCode *key,
+ struct GSF_PendingRequest *pr);
/**
* @param cls closure for it
*/
void
-GSF_iterate_pending_requests_ (GSF_PendingRequestIterator it, void *cls);
+GSF_iterate_pending_requests_ (GSF_PendingRequestIterator it,
+ void *cls);
/**
* @param cp the other peer involved (sender or receiver, NULL
* for loopback messages where we are both sender and receiver)
* @param message the actual message
- * @return GNUNET_OK if the message was well-formed,
- * GNUNET_SYSERR if the message was malformed (close connection,
+ * @return #GNUNET_OK if the message was well-formed,
+ * #GNUNET_SYSERR if the message was malformed (close connection,
* do not cache under any circumstances)
*/
int
GSF_dht_lookup_ (struct GSF_PendingRequest *pr);
+/**
+ * Consider downloading via cadet (if possible)
+ *
+ * @param pr the pending request to process
+ */
+void
+GSF_cadet_lookup_ (struct GSF_PendingRequest *pr);
+
+
/**
* Function to be called after we're done processing
* replies from the local lookup.
* @param pr the pending request we were processing
* @param result final datastore lookup result
*/
-typedef void (*GSF_LocalLookupContinuation) (void *cls,
- struct GSF_PendingRequest * pr,
- enum GNUNET_BLOCK_EvaluationResult
- result);
+typedef void
+(*GSF_LocalLookupContinuation) (void *cls,
+ struct GSF_PendingRequest *pr,
+ enum GNUNET_BLOCK_EvaluationResult result);
/**
*
* @param pr the pending request to process
* @param cont function to call at the end
- * @param cont_cls closure for cont
+ * @param cont_cls closure for @a cont
*/
void
GSF_local_lookup_ (struct GSF_PendingRequest *pr,
- GSF_LocalLookupContinuation cont, void *cont_cls);
+ GSF_LocalLookupContinuation cont,
+ void *cont_cls);
/**
*
* @param pr request
* @param target
- * @return GNUNET_YES if this request could be forwarded to the given peer
+ * @return #GNUNET_YES if this request could be forwarded to the given peer
*/
int
GSF_pending_request_test_target_ (struct GSF_PendingRequest *pr,
projects / oweals / gnunet.git / blobdiff