hdrs

1 files changed, 197 insertions, 0 deletions

diff --git a/src/fs/gnunet-service-fs_pr.h b/src/fs/gnunet-service-fs_pr.h
new file mode 100644
index 000000000..b4dd82839
--- /dev/null
+++ b/src/fs/gnunet-service-fs_pr.h
@@ -0,0 +1,197 @@
+/*
+     This file is part of GNUnet.
+     (C) 2009, 2010 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
+     by the Free Software Foundation; either version 3, or (at your
+     option) any later version.
+
+     GNUnet is distributed in the hope that it will be useful, but
+     WITHOUT ANY WARRANTY; without even the implied warranty of
+     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+     General Public License for more details.
+
+     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.
+*/
+
+/**
+ * @file fs/gnunet-service-fs_pr.h
+ * @brief API to handle pending requests
+ * @author Christian Grothoff
+ */
+#ifndef GNUNET_SERVICE_FS_PR_H
+#define GNUNET_SERVICE_FS_PR_H
+
+#include "gnunet-service-fs.h"
+
+
+/**
+ * Options for pending requests (bits to be ORed).
+ */
+enum GSF_PendingRequestOptions
+  {
+    /**
+     * Request must only be processed locally.
+     */
+    GSF_PRO_LOCAL_ONLY = 1,
+    
+    /**
+     * Request must only be forwarded (no routing)
+     */
+    GSF_PRO_FORWARD_ONLY = 2,
+
+    /**
+     * Request persists indefinitely (no expiration).
+     */
+    GSF_PRO_REQUEST_EXPIRES = 4,
+
+    /**
+     * Request is allowed to refresh bloomfilter and change mingle value.
+     */
+    GSF_PRO_BLOOMFILTER_FULL_REFRESH = 8,
+
+    /**
+     * Request priority is allowed to be exceeded.
+     */
+    GSF_PRO_PRIORITY_UNLIMITED = 16,
+
+    /**
+     * Option mask for typical local requests.
+     */
+    GSF_PRO_LOCAL_REQUEST = (GSF_PRO_BLOOMFILTER_FULL_REFRESH | GSF_PRO_PRIORITY_UNLIMITED)
+  };
+
+
+/**
+ * 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 
+ * and will also not be called anymore after a call signalling
+ * expiration.
+ *
+ * @param cls user-specified closure
+ * @param pr handle to the original pending request
+ * @param data response data, NULL on request expiration
+ * @param data_len number of bytes in data
+ */
+typedef void (*GSF_PendingRequestReplyHandler)(void *cls,
+                                               struct GSF_PendingRequest *pr,
+                                               const void *data,
+                                               size_t data_len);
+
+
+/**
+ * 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 bloom filter for known replies, can be NULL
+ * @param mingle mingle value for bf
+ * @param anonymity_level desired anonymity level
+ * @param priority maximum outgoing cummulative request priority to use
+ * @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,
+                             struct GNUNET_CONTAINER_BloomFilter *bf,
+                             int32_t mingle,
+                             uint32_t anonymity_level,
+                             uint32_t priority,
+                             const GNUNET_HashCode *replies_seen,
+                             unsigned int replies_seen_count,
+                             GSF_PendingRequestReplyHandler rh,
+                             void *rh_cls);
+
+
+/**
+ * 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 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) or used
+ */
+size_t
+GSF_pending_request_get_message_ (struct GSF_PendingRequest *pr,
+                                  size_t buf_size,
+                                  void *buf);
+
+
+/**
+ * Explicitly cancel a pending request.
+ *
+ * @param pr request to cancel
+ */
+void
+GSF_pending_request_cancel_ (struct GSF_PendingRequest *pr);
+
+
+/**
+ * Signature of function called on each request.
+ *
+ * @param cls closure
+ * @param key query for the request
+ * @param pr handle to the pending request
+ */
+typedef int (*GSF_PendingRequestIterator)(void *cls,
+                                          const GNUNET_HashCode *key,
+                                          struct GSF_PendingRequest *pr);
+
+
+/**
+ * Iterate over all pending requests.
+ *
+ * @param it function to call for each request
+ * @param cls closure for it
+ */
+void
+GSF_iterate_pending_requests_ (GSF_PendingRequestIterator it,
+                               void *cls);
+
+
+
+/**
+ * Register callback to invoke on request destruction.
+ *
+ * @param pr request to monitor
+ * @param it function to call on destruction
+ * @param it_cls closure for it
+ */
+void
+GSF_pending_request_register_destroy_callback_ (struct GSF_PendingRequest *pr,
+                                       GSF_PendingRequestIterator it,
+                                       void *it_cls);
+
+
+/**
+ * Unregister callback to invoke on request destruction.
+ *
+ * @param pr request to stop monitoring
+ * @param it function to no longer call on destruction
+ * @param it_cls closure for it
+ */
+void
+GSF_pending_request_unregister_destroy_callback_ (struct GSF_PendingRequest *pr,
+                                                  GSF_PendingRequestIterator it,
+                                                  void *it_cls);
+
+
+#endif
+/* end of gnunet-service-fs_pr.h */