aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/fs/fs_dirmetascan.c8
-rw-r--r--src/fs/fs_download.c64
-rw-r--r--src/fs/fs_file_information.c69
-rw-r--r--src/fs/fs_list_indexed.c8
-rw-r--r--src/fs/fs_namespace.c15
-rw-r--r--src/fs/fs_uri.c17
-rw-r--r--src/include/gnunet_fs_service.h2
7 files changed, 1 insertions, 182 deletions
diff --git a/src/fs/fs_dirmetascan.c b/src/fs/fs_dirmetascan.c
index cb50182f9..8dd216324 100644
--- a/src/fs/fs_dirmetascan.c
+++ b/src/fs/fs_dirmetascan.c
@@ -112,14 +112,6 @@ GNUNET_FS_directory_scan_abort (struct GNUNET_FS_DirScanner *ds)
112} 112}
113 113
114 114
115/**
116 * Obtain the result of the scan after the scan has signalled
117 * completion. Must not be called prior to completion. The 'ds' is
118 * freed as part of this call.
119 *
120 * @param ds directory scanner structure
121 * @return the results of the scan (a directory tree)
122 */
123struct GNUNET_FS_ShareTreeItem * 115struct GNUNET_FS_ShareTreeItem *
124GNUNET_FS_directory_scan_get_result (struct GNUNET_FS_DirScanner *ds) 116GNUNET_FS_directory_scan_get_result (struct GNUNET_FS_DirScanner *ds)
125{ 117{
diff --git a/src/fs/fs_download.c b/src/fs/fs_download.c
index e0ad8cd1d..3f5ac6c64 100644
--- a/src/fs/fs_download.c
+++ b/src/fs/fs_download.c
@@ -2096,36 +2096,6 @@ create_download_context (struct GNUNET_FS_Handle *h,
2096} 2096}
2097 2097
2098 2098
2099/**
2100 * Download parts of a file. Note that this will store
2101 * the blocks at the respective offset in the given file. Also, the
2102 * download is still using the blocking of the underlying FS
2103 * encoding. As a result, the download may *write* outside of the
2104 * given boundaries (if offset and length do not match the 32k FS
2105 * block boundaries). <p>
2106 *
2107 * This function should be used to focus a download towards a
2108 * particular portion of the file (optimization), not to strictly
2109 * limit the download to exactly those bytes.
2110 *
2111 * @param h handle to the file sharing subsystem
2112 * @param uri the URI of the file (determines what to download); CHK or LOC URI
2113 * @param meta known metadata for the file (can be NULL)
2114 * @param filename where to store the file, maybe NULL (then no file is
2115 * created on disk and data must be grabbed from the callbacks)
2116 * @param tempname where to store temporary file data, not used if filename is non-NULL;
2117 * can be NULL (in which case we will pick a name if needed); the temporary file
2118 * may already exist, in which case we will try to use the data that is there and
2119 * if it is not what is desired, will overwrite it
2120 * @param offset at what offset should we start the download (typically 0)
2121 * @param length how many bytes should be downloaded starting at offset
2122 * @param anonymity anonymity level to use for the download
2123 * @param options various options
2124 * @param cctx initial value for the client context for this download
2125 * @param parent parent download to associate this download with (use NULL
2126 * for top-level downloads; useful for manually-triggered recursive downloads)
2127 * @return context that can be used to control this download
2128 */
2129struct GNUNET_FS_DownloadContext * 2099struct GNUNET_FS_DownloadContext *
2130GNUNET_FS_download_start (struct GNUNET_FS_Handle *h, 2100GNUNET_FS_download_start (struct GNUNET_FS_Handle *h,
2131 const struct GNUNET_FS_Uri *uri, 2101 const struct GNUNET_FS_Uri *uri,
@@ -2163,40 +2133,6 @@ GNUNET_FS_download_start (struct GNUNET_FS_Handle *h,
2163} 2133}
2164 2134
2165 2135
2166/**
2167 * Download parts of a file based on a search result. The download
2168 * will be associated with the search result (and the association
2169 * will be preserved when serializing/deserializing the state).
2170 * If the search is stopped, the download will not be aborted but
2171 * be 'promoted' to a stand-alone download.
2172 *
2173 * As with the other download function, this will store
2174 * the blocks at the respective offset in the given file. Also, the
2175 * download is still using the blocking of the underlying FS
2176 * encoding. As a result, the download may *write* outside of the
2177 * given boundaries (if offset and length do not match the 32k FS
2178 * block boundaries). <p>
2179 *
2180 * The given range can be used to focus a download towards a
2181 * particular portion of the file (optimization), not to strictly
2182 * limit the download to exactly those bytes.
2183 *
2184 * @param h handle to the file sharing subsystem
2185 * @param sr the search result to use for the download (determines uri and
2186 * meta data and associations)
2187 * @param filename where to store the file, maybe NULL (then no file is
2188 * created on disk and data must be grabbed from the callbacks)
2189 * @param tempname where to store temporary file data, not used if filename is non-NULL;
2190 * can be NULL (in which case we will pick a name if needed); the temporary file
2191 * may already exist, in which case we will try to use the data that is there and
2192 * if it is not what is desired, will overwrite it
2193 * @param offset at what offset should we start the download (typically 0)
2194 * @param length how many bytes should be downloaded starting at offset
2195 * @param anonymity anonymity level to use for the download
2196 * @param options various download options
2197 * @param cctx initial value for the client context for this download
2198 * @return context that can be used to control this download
2199 */
2200struct GNUNET_FS_DownloadContext * 2136struct GNUNET_FS_DownloadContext *
2201GNUNET_FS_download_start_from_search (struct GNUNET_FS_Handle *h, 2137GNUNET_FS_download_start_from_search (struct GNUNET_FS_Handle *h,
2202 struct GNUNET_FS_SearchResult *sr, 2138 struct GNUNET_FS_SearchResult *sr,
diff --git a/src/fs/fs_file_information.c b/src/fs/fs_file_information.c
index c5faa14d4..dc5db9d3f 100644
--- a/src/fs/fs_file_information.c
+++ b/src/fs/fs_file_information.c
@@ -83,20 +83,6 @@ GNUNET_FS_file_information_set_filename (struct GNUNET_FS_FileInformation *s,
83} 83}
84 84
85 85
86/**
87 * Create an entry for a file in a publish-structure.
88 *
89 * @param h handle to the file sharing subsystem
90 * @param client_info initial value for the client-info value for this entry
91 * @param filename name of the file or directory to publish
92 * @param keywords under which keywords should this file be available
93 * directly; can be NULL
94 * @param meta metadata for the file
95 * @param do_index #GNUNET_YES for index, #GNUNET_NO for insertion,
96 * #GNUNET_SYSERR for simulation
97 * @param bo block options
98 * @return publish structure entry for the file
99 */
100struct GNUNET_FS_FileInformation * 86struct GNUNET_FS_FileInformation *
101GNUNET_FS_file_information_create_from_file ( 87GNUNET_FS_file_information_create_from_file (
102 struct GNUNET_FS_Handle *h, 88 struct GNUNET_FS_Handle *h,
@@ -157,22 +143,6 @@ GNUNET_FS_file_information_create_from_file (
157} 143}
158 144
159 145
160/**
161 * Create an entry for a file in a publish-structure.
162 *
163 * @param h handle to the file sharing subsystem
164 * @param client_info initial value for the client-info value for this entry
165 * @param length length of the file
166 * @param data data for the file (should not be used afterwards by
167 * the caller; callee will "free")
168 * @param keywords under which keywords should this file be available
169 * directly; can be NULL
170 * @param meta metadata for the file
171 * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
172 * GNUNET_SYSERR for simulation
173 * @param bo block options
174 * @return publish structure entry for the file
175 */
176struct GNUNET_FS_FileInformation * 146struct GNUNET_FS_FileInformation *
177GNUNET_FS_file_information_create_from_data ( 147GNUNET_FS_file_information_create_from_data (
178 struct GNUNET_FS_Handle *h, 148 struct GNUNET_FS_Handle *h,
@@ -202,22 +172,6 @@ GNUNET_FS_file_information_create_from_data (
202} 172}
203 173
204 174
205/**
206 * Create an entry for a file in a publish-structure.
207 *
208 * @param h handle to the file sharing subsystem
209 * @param client_info initial value for the client-info value for this entry
210 * @param length length of the file
211 * @param reader function that can be used to obtain the data for the file
212 * @param reader_cls closure for "reader"
213 * @param keywords under which keywords should this file be available
214 * directly; can be NULL
215 * @param meta metadata for the file
216 * @param do_index #GNUNET_YES for index, #GNUNET_NO for insertion,
217 * #GNUNET_SYSERR for simulation
218 * @param bo block options
219 * @return publish structure entry for the file
220 */
221struct GNUNET_FS_FileInformation * 175struct GNUNET_FS_FileInformation *
222GNUNET_FS_file_information_create_from_reader ( 176GNUNET_FS_file_information_create_from_reader (
223 struct GNUNET_FS_Handle *h, 177 struct GNUNET_FS_Handle *h,
@@ -267,18 +221,6 @@ GNUNET_FS_file_information_is_directory (
267} 221}
268 222
269 223
270/**
271 * Create an entry for an empty directory in a publish-structure.
272 *
273 * @param h handle to the file sharing subsystem
274 * @param client_info initial value for the client-info value for this entry
275 * @param meta metadata for the directory
276 * @param keywords under which keywords should this directory be available
277 * directly; can be NULL
278 * @param bo block options
279 * @param filename name of the directory; can be NULL
280 * @return publish structure entry for the directory , NULL on error
281 */
282struct GNUNET_FS_FileInformation * 224struct GNUNET_FS_FileInformation *
283GNUNET_FS_file_information_create_empty_directory ( 225GNUNET_FS_file_information_create_empty_directory (
284 struct GNUNET_FS_Handle *h, 226 struct GNUNET_FS_Handle *h,
@@ -303,17 +245,6 @@ GNUNET_FS_file_information_create_empty_directory (
303} 245}
304 246
305 247
306/**
307 * Add an entry to a directory in a publish-structure. Clients
308 * should never modify publish structures that were passed to
309 * #GNUNET_FS_publish_start already.
310 *
311 * @param dir the directory
312 * @param ent the entry to add; the entry must not have been
313 * added to any other directory at this point and
314 * must not include @a dir in its structure
315 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
316 */
317int 248int
318GNUNET_FS_file_information_add (struct GNUNET_FS_FileInformation *dir, 249GNUNET_FS_file_information_add (struct GNUNET_FS_FileInformation *dir,
319 struct GNUNET_FS_FileInformation *ent) 250 struct GNUNET_FS_FileInformation *ent)
diff --git a/src/fs/fs_list_indexed.c b/src/fs/fs_list_indexed.c
index 0e16fb01b..6a2ddd93c 100644
--- a/src/fs/fs_list_indexed.c
+++ b/src/fs/fs_list_indexed.c
@@ -155,14 +155,6 @@ mq_error_handler (void *cls,
155} 155}
156 156
157 157
158/**
159 * Iterate over all indexed files.
160 *
161 * @param h handle to the file sharing subsystem
162 * @param iterator function to call on each indexed file
163 * @param iterator_cls closure for iterator
164 * @return NULL on error ('iter' is not called)
165 */
166struct GNUNET_FS_GetIndexedContext * 158struct GNUNET_FS_GetIndexedContext *
167GNUNET_FS_get_indexed_files (struct GNUNET_FS_Handle *h, 159GNUNET_FS_get_indexed_files (struct GNUNET_FS_Handle *h,
168 GNUNET_FS_IndexedFileProcessor iterator, 160 GNUNET_FS_IndexedFileProcessor iterator,
diff --git a/src/fs/fs_namespace.c b/src/fs/fs_namespace.c
index 155486be5..bc94dd1fc 100644
--- a/src/fs/fs_namespace.c
+++ b/src/fs/fs_namespace.c
@@ -423,21 +423,6 @@ sks_publish_cont (void *cls, const char *msg)
423} 423}
424 424
425 425
426/**
427 * Publish an SBlock on GNUnet.
428 *
429 * @param h handle to the file sharing subsystem
430 * @param ns namespace to publish in
431 * @param identifier identifier to use
432 * @param update update identifier to use
433 * @param meta metadata to use
434 * @param uri URI to refer to in the SBlock
435 * @param bo block options
436 * @param options publication options
437 * @param cont continuation
438 * @param cont_cls closure for cont
439 * @return NULL on error ('cont' will still be called)
440 */
441struct GNUNET_FS_PublishSksContext * 426struct GNUNET_FS_PublishSksContext *
442GNUNET_FS_publish_sks (struct GNUNET_FS_Handle *h, 427GNUNET_FS_publish_sks (struct GNUNET_FS_Handle *h,
443 const struct GNUNET_CRYPTO_EcdsaPrivateKey *ns, 428 const struct GNUNET_CRYPTO_EcdsaPrivateKey *ns,
diff --git a/src/fs/fs_uri.c b/src/fs/fs_uri.c
index 2d5566b54..cdea8b72d 100644
--- a/src/fs/fs_uri.c
+++ b/src/fs/fs_uri.c
@@ -91,14 +91,6 @@
91#include <unistdio.h> 91#include <unistdio.h>
92 92
93 93
94/**
95 * Get a unique key from a URI. This is for putting URIs
96 * into HashMaps. The key may change between FS implementations.
97 *
98 * @param uri uri to convert to a unique key
99 * @param key where to store the unique key
100 * @return #GNUNET_OK on success
101 */
102int 94int
103GNUNET_FS_uri_to_key (const struct GNUNET_FS_Uri *uri, 95GNUNET_FS_uri_to_key (const struct GNUNET_FS_Uri *uri,
104 struct GNUNET_HashCode *key) 96 struct GNUNET_HashCode *key)
@@ -723,15 +715,6 @@ GNUNET_FS_uri_ksk_get_keyword_count (const struct GNUNET_FS_Uri *uri)
723} 715}
724 716
725 717
726/**
727 * Iterate over all keywords in this keyword URI.
728 *
729 * @param uri ksk uri to get the keywords from
730 * @param iterator function to call on each keyword
731 * @param iterator_cls closure for iterator
732 * @return -1 if this is not a keyword URI, otherwise number of
733 * keywords iterated over until iterator aborted
734 */
735int 718int
736GNUNET_FS_uri_ksk_get_keywords (const struct GNUNET_FS_Uri *uri, 719GNUNET_FS_uri_ksk_get_keywords (const struct GNUNET_FS_Uri *uri,
737 GNUNET_FS_KeywordIterator iterator, 720 GNUNET_FS_KeywordIterator iterator,
diff --git a/src/include/gnunet_fs_service.h b/src/include/gnunet_fs_service.h
index 6b664169a..f40670ea5 100644
--- a/src/include/gnunet_fs_service.h
+++ b/src/include/gnunet_fs_service.h
@@ -111,7 +111,7 @@ typedef int
111 * into HashMaps. The key may change between FS implementations. 111 * into HashMaps. The key may change between FS implementations.
112 * 112 *
113 * @param uri uri to convert to a unique key 113 * @param uri uri to convert to a unique key
114 * @param key wherer to store the unique key 114 * @param key where to store the unique key
115 * @return #GNUNET_OK on success 115 * @return #GNUNET_OK on success
116 */ 116 */
117int 117int