/*
This file is part of GNUnet.
- (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
*/
enum GSF_PendingRequestOptions
{
+
+ /**
+ * No special options (P2P-default).
+ */
+ GSF_PRO_DEFAULTS = 0,
+
/**
* Request must only be processed locally.
*/
/**
* Request persists indefinitely (no expiration).
*/
- GSF_PRO_REQUEST_EXPIRES = 4,
+ GSF_PRO_REQUEST_NEVER_EXPIRES = 4,
/**
* Request is allowed to refresh bloomfilter and change mingle value.
* Option mask for typical local requests.
*/
GSF_PRO_LOCAL_REQUEST =
- (GSF_PRO_BLOOMFILTER_FULL_REFRESH | GSF_PRO_PRIORITY_UNLIMITED)
+ (GSF_PRO_BLOOMFILTER_FULL_REFRESH | GSF_PRO_PRIORITY_UNLIMITED | GSF_PRO_REQUEST_NEVER_EXPIRES)
};
/**
* 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?
+ * Has this request been started yet (local/p2p operations)? Or are
+ * we still constructing it?
*/
- int has_target;
+ int has_started;
};
* Handle a reply to a pending request. Also called if a request
* expires (then with data == NULL). The handler may be called
* many times (depending on the request type), but will not be
- * called during or after a call to GSF_pending_request_cancel
+ * called during or after a call to GSF_pending_request_cancel
* and will also not be called anymore after a call signalling
* expiration.
*
* @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 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
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);
/**
- * Create a new pending request.
+ * Create a new pending request.
*
* @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
* @param ttl current time-to-live for the request
* @param sender_pid peer ID to use for the sender when forwarding, 0 for none;
* reference counter is taken over by this function
+ * @param origin_pid peer ID of origin of query (do not loop back)
* @param replies_seen hash codes of known local replies
* @param replies_seen_count size of the 'replies_seen' array
* @param rh handle to call when we get a reply
* @param rh_cls closure for rh
* @return handle for the new pending request
*/
-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_PeerIdentity
- *target,
- 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,
- const GNUNET_HashCode *
- replies_seen,
- unsigned int
- replies_seen_count,
- GSF_PendingRequestReplyHandler
- rh, void *rh_cls);
+struct GSF_PendingRequest *
+GSF_pending_request_create_ (enum GSF_PendingRequestOptions options,
+ enum GNUNET_BLOCK_Type type,
+ 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,
+ GNUNET_PEER_Id sender_pid,
+ GNUNET_PEER_Id origin_pid,
+ const struct GNUNET_HashCode * replies_seen,
+ unsigned int replies_seen_count,
+ GSF_PendingRequestReplyHandler rh, void *rh_cls);
/**
*/
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);
/**
* Obtain the public data associated with a pending request
- *
+ *
* @param pr pending request
* @return associated public data
*/
-struct GSF_PendingRequestData *GSF_pending_request_get_data_ (struct
- GSF_PendingRequest
- *pr);
+struct GSF_PendingRequestData *
+GSF_pending_request_get_data_ (struct GSF_PendingRequest *pr);
/**
* Test if two pending requests are compatible (would generate
* the same query modulo filters and should thus be processed
* jointly).
- *
+ *
* @param pra a pending request
- * @param pra another pending request
+ * @param prb another pending request
* @return GNUNET_OK if the requests are compatible
*/
int
* @return number of bytes needed (if buf_size too small) or used
*/
size_t
-
-
-
-
-
-
GSF_pending_request_get_message_ (struct GSF_PendingRequest *pr,
size_t buf_size, void *buf);
* @return GNUNET_YES to continue to iterate
*/
typedef int (*GSF_PendingRequestIterator) (void *cls,
- const GNUNET_HashCode * key,
+ const struct GNUNET_HashCode * key,
struct GSF_PendingRequest * pr);
* @param it function to call for each request
* @param cls closure for it
*/
-void GSF_iterate_pending_requests_ (GSF_PendingRequestIterator it, void *cls);
+void
+GSF_iterate_pending_requests_ (GSF_PendingRequestIterator it, void *cls);
/**
*
* @param pr the pending request to process
*/
-void GSF_dht_lookup_ (struct GSF_PendingRequest *pr);
+void
+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);
/**
GSF_LocalLookupContinuation cont, void *cont_cls);
+/**
+ * Is the given target a legitimate peer for forwarding the given request?
+ *
+ * @param pr request
+ * @param target
+ * @return GNUNET_YES if this request could be forwarded to the given peer
+ */
+int
+GSF_pending_request_test_target_ (struct GSF_PendingRequest *pr,
+ const struct GNUNET_PeerIdentity *target);
+
+
+
/**
* Setup the subsystem.
*/
-void GSF_pending_request_init_ (void);
+void
+GSF_pending_request_init_ (void);
/**
* Shutdown the subsystem.
*/
-void GSF_pending_request_done_ (void);
+void
+GSF_pending_request_done_ (void);
#endif
projects / oweals / gnunet.git / blobdiff