* Options for pending requests (bits to be ORed).
*/
enum GSF_PendingRequestOptions
- {
+{
/**
* Request must only be processed locally.
*/
- GSF_PRO_LOCAL_ONLY = 1,
-
+ GSF_PRO_LOCAL_ONLY = 1,
+
/**
* Request must only be forwarded (no routing)
*/
- GSF_PRO_FORWARD_ONLY = 2,
+ GSF_PRO_FORWARD_ONLY = 2,
/**
* Request persists indefinitely (no expiration).
*/
- GSF_PRO_REQUEST_EXPIRES = 4,
+ GSF_PRO_REQUEST_EXPIRES = 4,
/**
* Request is allowed to refresh bloomfilter and change mingle value.
*/
- GSF_PRO_BLOOMFILTER_FULL_REFRESH = 8,
+ GSF_PRO_BLOOMFILTER_FULL_REFRESH = 8,
/**
* Request priority is allowed to be exceeded.
*/
- GSF_PRO_PRIORITY_UNLIMITED = 16,
+ GSF_PRO_PRIORITY_UNLIMITED = 16,
/**
* Option mask for typical local requests.
*/
- GSF_PRO_LOCAL_REQUEST = (GSF_PRO_BLOOMFILTER_FULL_REFRESH | GSF_PRO_PRIORITY_UNLIMITED)
-
- };
+ GSF_PRO_LOCAL_REQUEST =
+ (GSF_PRO_BLOOMFILTER_FULL_REFRESH | GSF_PRO_PRIORITY_UNLIMITED)
+};
/**
* Namespace to query, only set if the type is SBLOCK.
*/
GNUNET_HashCode namespace;
-
+
/**
* Identity of a peer hosting the content, only set if
* 'has_target' is GNUNET_YES.
*/
struct GNUNET_PeerIdentity target;
+ /**
+ * Fields for the plan module to track a DLL with the request.
+ */
+ struct GSF_RequestPlanReference *rpr_head;
+
+ /**
+ * Fields for the plan module to track a DLL with the request.
+ */
+ struct GSF_RequestPlanReference *rpr_tail;
+
/**
* Current TTL for the request.
*/
* Options for the request.
*/
enum GSF_PendingRequestOptions options;
-
+
/**
* Type of the requested block.
*/
* expiration.
*
* @param cls user-specified closure
+ * @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 type type of the block
* @param data response data, NULL on request expiration
* @param data_len number of bytes in data
- * @param more GNUNET_YES if the request remains active (may call
- * this function again), GNUNET_NO if the request is
- * finished (client must not call GSF_pending_request_cancel_)
*/
-typedef void (*GSF_PendingRequestReplyHandler)(void *cls,
- struct GSF_PendingRequest *pr,
- struct GNUNET_TIME_Absolute expiration,
- const void *data,
- size_t data_len,
- int more);
+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);
/**
*/
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);
+ 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);
/**
*/
void
GSF_pending_request_update_ (struct GSF_PendingRequest *pr,
- const GNUNET_HashCode *replies_seen,
- unsigned int replies_seen_count);
+ const GNUNET_HashCode * replies_seen,
+ unsigned int replies_seen_count);
/**
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
+ * @return GNUNET_OK if the requests are compatible
+ */
+int
+GSF_pending_request_is_compatible_ (struct GSF_PendingRequest *pra,
+ struct GSF_PendingRequest *prb);
+
+
/**
* Generate the message corresponding to the given pending request for
* transmission to other peers (or at least determine its size).
*
* @param pr request to generate the message for
- * @param do_route are we routing the reply
* @param buf_size number of bytes available in buf
* @param buf where to copy the message (can be NULL)
* @return number of bytes needed (if buf_size too small) or used
*/
size_t
GSF_pending_request_get_message_ (struct GSF_PendingRequest *pr,
- int do_route,
- size_t buf_size,
- void *buf);
+ size_t buf_size, void *buf);
/**
* Explicitly cancel a pending request.
*
* @param pr request to cancel
+ * @param full_cleanup fully purge the request
*/
void
-GSF_pending_request_cancel_ (struct GSF_PendingRequest *pr);
+GSF_pending_request_cancel_ (struct GSF_PendingRequest *pr, int full_cleanup);
/**
* @param pr handle to the pending request
* @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 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);
/**
*/
int
GSF_handle_p2p_content_ (struct GSF_ConnectedPeer *cp,
- const struct GNUNET_MessageHeader *message);
+ const struct GNUNET_MessageHeader *message);
/**
* @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);
/**
*/
void
GSF_local_lookup_ (struct GSF_PendingRequest *pr,
- GSF_LocalLookupContinuation cont,
- void *cont_cls);
+ GSF_LocalLookupContinuation cont, void *cont_cls);
/**
* Setup the subsystem.
- *
- * @param cfg configuration to use
*/
void
GSF_pending_request_init_ (void);
projects / oweals / gnunet.git / blobdiff