-eliminate printing warning on MAGIC missmatch (#2138)
[oweals/gnunet.git] / src / fs / gnunet-service-fs_pr.h
index f2e7bcf6267a2f366d251b304b23c88763026840..92827f76bb053a9da6eb99e4665c6bf921d9f404 100644 (file)
  */
 enum GSF_PendingRequestOptions
 {
+
+  /**
+   * No special options (P2P-default).
+   */
+  GSF_PRO_DEFAULTS = 0,
+
     /**
      * Request must only be processed locally.
      */
@@ -47,7 +53,7 @@ enum GSF_PendingRequestOptions
     /**
      * 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.
@@ -63,7 +69,7 @@ enum GSF_PendingRequestOptions
      * 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)
 };
 
 
@@ -146,6 +152,12 @@ struct GSF_PendingRequestData
    */
   int has_target;
 
+  /**
+   * Has this request been started yet (local/p2p operations)?  Or are
+   * we still constructing it?
+   */
+  int has_started;
+
 };
 
 
@@ -153,7 +165,7 @@ struct GSF_PendingRequestData
  * 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.
  *
@@ -162,6 +174,7 @@ struct GSF_PendingRequestData
  * @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
@@ -174,13 +187,15 @@ typedef void (*GSF_PendingRequestReplyHandler) (void *cls,
                                                 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
@@ -195,39 +210,27 @@ typedef void (*GSF_PendingRequestReplyHandler) (void *cls,
  * @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 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,
+                             GNUNET_PEER_Id origin_pid,
+                             const GNUNET_HashCode * replies_seen,
+                             unsigned int replies_seen_count,
+                             GSF_PendingRequestReplyHandler rh, void *rh_cls);
 
 
 /**
@@ -238,33 +241,34 @@ struct GSF_PendingRequest *GSF_pending_request_create_ (enum
  * @param replies_seen hash codes of replies that we've seen
  * @param replies_seen_count size of the replies_seen array
  */
-void GSF_pending_request_update_ (struct GSF_PendingRequest *pr,
-                                  const GNUNET_HashCode * replies_seen,
-                                  unsigned int replies_seen_count);
+void
+GSF_pending_request_update_ (struct GSF_PendingRequest *pr,
+                             const 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 GSF_pending_request_is_compatible_ (struct GSF_PendingRequest *pra,
-                                        struct GSF_PendingRequest *prb);
+int
+GSF_pending_request_is_compatible_ (struct GSF_PendingRequest *pra,
+                                    struct GSF_PendingRequest *prb);
 
 
 /**
@@ -276,9 +280,9 @@ int GSF_pending_request_is_compatible_ (struct GSF_PendingRequest *pra,
  * @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, size_t buf_size,
-                                                     void *buf);
+size_t
+GSF_pending_request_get_message_ (struct GSF_PendingRequest *pr,
+                                  size_t buf_size, void *buf);
 
 
 /**
@@ -287,8 +291,8 @@ size_t             GSF_pending_request_get_message_ (struct GSF_PendingRequest
  * @param pr request to cancel
  * @param full_cleanup fully purge the request
  */
-void GSF_pending_request_cancel_ (struct GSF_PendingRequest *pr,
-                                  int full_cleanup);
+void
+GSF_pending_request_cancel_ (struct GSF_PendingRequest *pr, int full_cleanup);
 
 
 /**
@@ -311,7 +315,8 @@ typedef int (*GSF_PendingRequestIterator) (void *cls,
  * @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);
 
 
 /**
@@ -327,8 +332,9 @@ void GSF_iterate_pending_requests_ (GSF_PendingRequestIterator it, void *cls);
  *         GNUNET_SYSERR if the message was malformed (close connection,
  *         do not cache under any circumstances)
  */
-int GSF_handle_p2p_content_ (struct GSF_ConnectedPeer *cp,
-                             const struct GNUNET_MessageHeader *message);
+int
+GSF_handle_p2p_content_ (struct GSF_ConnectedPeer *cp,
+                         const struct GNUNET_MessageHeader *message);
 
 
 /**
@@ -336,7 +342,8 @@ int GSF_handle_p2p_content_ (struct GSF_ConnectedPeer *cp,
  *
  * @param pr the pending request to process
  */
-void GSF_dht_lookup_ (struct GSF_PendingRequest *pr);
+void
+GSF_dht_lookup_ (struct GSF_PendingRequest *pr);
 
 
 /**
@@ -360,20 +367,36 @@ typedef void (*GSF_LocalLookupContinuation) (void *cls,
  * @param cont function to call at the end
  * @param cont_cls closure for cont
  */
-void GSF_local_lookup_ (struct GSF_PendingRequest *pr,
-                        GSF_LocalLookupContinuation cont, void *cont_cls);
+void
+GSF_local_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