/*
This file is part of GNUnet
- (C) 2004--2013 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2004--2013 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
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.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
- * @file include/gnunet_fs_service.h
- * @brief API for file-sharing via GNUnet
* @author Christian Grothoff
+ *
+ * @file
+ * API for file sharing via GNUnet
+ *
+ * @defgroup fs FS service
+ * File sharing
+ *
+ * @see [Documentation](https://gnunet.org/file-sharing-service)
+ *
+ * @{
*/
#ifndef GNUNET_FS_LIB_H
#define GNUNET_FS_LIB_H
* 9.0.0: CPS-style integrated API
* 9.1.1: asynchronous directory scanning
* 9.2.0: unified K-Block and S-block format (#2564)
+ * 9.3.0: base32crockford encoded URLs
*/
-#define GNUNET_FS_VERSION 0x00090200
+#define GNUNET_FS_VERSION 0x00090300
/* ******************** URI API *********************** */
* @param is_mandatory is the keyword mandatory (in a search)
* @return #GNUNET_OK to continue to iterate, #GNUNET_SYSERR to abort
*/
-typedef int (*GNUNET_FS_KeywordIterator) (void *cls, const char *keyword,
- int is_mandatory);
+typedef int
+(*GNUNET_FS_KeywordIterator) (void *cls,
+ const char *keyword,
+ int is_mandatory);
* @return NULL on error
*/
struct GNUNET_FS_Uri *
-GNUNET_FS_uri_parse (const char *uri, char **emsg);
+GNUNET_FS_uri_parse (const char *uri,
+ char **emsg);
/**
/**
* Construct a location URI (this peer will be used for the location).
+ * This function should only be called from within gnunet-service-fs,
+ * as it requires the peer's private key which is generally unavailable
+ * to processes directly under the user's control. However, for
+ * testing and as it logically fits under URIs, it is in this API.
*
- * @param baseUri content offered by the sender
- * @param cfg configuration information (used to find our hostkey)
+ * @param base_uri content offered by the sender
+ * @param sign_key private key of the peer
* @param expiration_time how long will the content be offered?
* @return the location URI, NULL on error
*/
struct GNUNET_FS_Uri *
-GNUNET_FS_uri_loc_create (const struct GNUNET_FS_Uri *baseUri,
- const struct GNUNET_CONFIGURATION_Handle *cfg,
+GNUNET_FS_uri_loc_create (const struct GNUNET_FS_Uri *base_uri,
+ const struct GNUNET_CRYPTO_EddsaPrivateKey *sign_key,
struct GNUNET_TIME_Absolute expiration_time);
* if keywords is not legal (i.e. empty).
*/
struct GNUNET_FS_Uri *
-GNUNET_FS_uri_ksk_create (const char *keywords, char **emsg);
+GNUNET_FS_uri_ksk_create (const char *keywords,
+ char **emsg);
/**
* @return #GNUNET_OK on success
*/
int
-GNUNET_FS_getopt_set_keywords (struct GNUNET_GETOPT_CommandLineProcessorContext
- *ctx, void *scls, const char *option,
+GNUNET_FS_getopt_set_keywords (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx,
+ void *scls,
+ const char *option,
const char *value);
* @return #GNUNET_OK on success
*/
int
-GNUNET_FS_getopt_set_metadata (struct GNUNET_GETOPT_CommandLineProcessorContext
- *ctx, void *scls, const char *option,
+GNUNET_FS_getopt_set_metadata (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx,
+ void *scls,
+ const char *option,
const char *value);
*/
const struct GNUNET_FS_Uri *chk_uri;
+ /**
+ * SKS URI of the file (if the download had been completed)
+ */
+ const struct GNUNET_FS_Uri *sks_uri;
+
} resume;
/**
{
/**
- * URI of the file.
+ * CHK URI of the file.
*/
const struct GNUNET_FS_Uri *chk_uri;
+ /**
+ * SKS URI of the file (if the download had been completed)
+ */
+ const struct GNUNET_FS_Uri *sks_uri;
+
} completed;
/**
* will be passed to future callbacks in the respective
* field in the `struct GNUNET_FS_ProgressInfo`.
*/
-typedef void *(*GNUNET_FS_ProgressCallback) (void *cls,
- const struct GNUNET_FS_ProgressInfo *info);
+typedef void *
+(*GNUNET_FS_ProgressCallback) (void *cls,
+ const struct GNUNET_FS_ProgressInfo *info);
/**
*/
struct GNUNET_FS_Handle *
GNUNET_FS_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
- const char *client_name, GNUNET_FS_ProgressCallback upcb,
- void *upcb_cls, enum GNUNET_FS_Flags flags, ...);
+ const char *client_name,
+ GNUNET_FS_ProgressCallback upcb,
+ void *upcb_cls,
+ enum GNUNET_FS_Flags flags,
+ ...);
/**
* Close our connection with the file-sharing service.
- * The callback given to GNUNET_FS_start will no longer be
+ * The callback given to #GNUNET_FS_start() will no longer be
* called after this function returns.
+ * This function MUST NOT be called from within the
+ * callback itself.
*
- * @param h handle that was returned from GNUNET_FS_start
+ * @param h handle that was returned from #GNUNET_FS_start()
*/
void
GNUNET_FS_stop (struct GNUNET_FS_Handle *h);
* this entry from the directory, #GNUNET_SYSERR
* to abort the iteration
*/
-typedef int (*GNUNET_FS_FileInformationProcessor) (void *cls,
- struct
- GNUNET_FS_FileInformation *
- fi, uint64_t length,
- struct
- GNUNET_CONTAINER_MetaData *
- meta,
- struct GNUNET_FS_Uri ** uri,
- struct GNUNET_FS_BlockOptions
- * bo, int *do_index,
- void **client_info);
+typedef int
+(*GNUNET_FS_FileInformationProcessor) (void *cls,
+ struct GNUNET_FS_FileInformation *fi,
+ uint64_t length,
+ struct GNUNET_CONTAINER_MetaData *meta,
+ struct GNUNET_FS_Uri ** uri,
+ struct GNUNET_FS_BlockOptions *bo,
+ int *do_index,
+ void **client_info);
/**
GNUNET_FS_file_information_create_from_file (struct GNUNET_FS_Handle *h,
void *client_info,
const char *filename,
- const struct GNUNET_FS_Uri
- *keywords,
- const struct
- GNUNET_CONTAINER_MetaData *meta,
+ const struct GNUNET_FS_Uri *keywords,
+ const struct GNUNET_CONTAINER_MetaData *meta,
int do_index,
- const struct GNUNET_FS_BlockOptions
- *bo);
+ const struct GNUNET_FS_BlockOptions *bo);
/**
*/
struct GNUNET_FS_FileInformation *
GNUNET_FS_file_information_create_from_data (struct GNUNET_FS_Handle *h,
- void *client_info, uint64_t length,
+ void *client_info,
+ uint64_t length,
void *data,
- const struct GNUNET_FS_Uri
- *keywords,
- const struct
- GNUNET_CONTAINER_MetaData *meta,
+ const struct GNUNET_FS_Uri *keywords,
+ const struct GNUNET_CONTAINER_MetaData *meta,
int do_index,
- const struct GNUNET_FS_BlockOptions
- *bo);
+ const struct GNUNET_FS_BlockOptions *bo);
/**
* @param emsg location for the reader to store an error message
* @return number of bytes written, usually @a max, 0 on error
*/
-typedef size_t (*GNUNET_FS_DataReader) (void *cls, uint64_t offset, size_t max,
- void *buf, char **emsg);
+typedef size_t
+(*GNUNET_FS_DataReader) (void *cls,
+ uint64_t offset,
+ size_t max,
+ void *buf,
+ char **emsg);
/**
/**
* Add an entry to a directory in a publish-structure. Clients
* should never modify publish structures that were passed to
- * #GNUNET_FS_publish_start already.
+ * #GNUNET_FS_publish_start() already.
*
* @param dir the directory
* @param ent the entry to add; the entry must not have been
* @param uri URI under which the block is now available, NULL on error
* @param emsg error message, NULL on success
*/
-typedef void (*GNUNET_FS_PublishContinuation) (void *cls,
- const struct GNUNET_FS_Uri *uri,
- const char *emsg);
+typedef void
+(*GNUNET_FS_PublishContinuation) (void *cls,
+ const struct GNUNET_FS_Uri *uri,
+ const char *emsg);
/**
* @param file_id hash of the contents of the indexed file
* @return #GNUNET_OK to continue iteration, #GNUNET_SYSERR to abort
*/
-typedef int (*GNUNET_FS_IndexedFileProcessor) (void *cls, const char *filename,
- const struct GNUNET_HashCode * file_id);
+typedef int
+(*GNUNET_FS_IndexedFileProcessor) (void *cls,
+ const char *filename,
+ const struct GNUNET_HashCode *file_id);
/**
GNUNET_FS_download_stop (struct GNUNET_FS_DownloadContext *dc, int do_delete);
+/**
+ * Suspend a download.
+ *
+ * @param dc handle for the download
+ */
+void
+GNUNET_FS_download_suspend (struct GNUNET_FS_DownloadContext *dc);
+
+
+/**
+ * Resume a suspended download.
+ *
+ * @param dc handle for the download
+ */
+void
+GNUNET_FS_download_resume (struct GNUNET_FS_DownloadContext *dc);
+
+
/* ******************** Directory API *********************** */
/**
- * Opaqe handle to an asynchronous directory scanning activity.
+ * Opaque handle to an asynchronous directory scanning activity.
*/
struct GNUNET_FS_DirScanner;
* Start a directory scanner.
*
* @param filename name of the directory to scan
- * @param disable_extractor #GNUNET_YES to not to run libextractor on files (only build a tree)
+ * @param disable_extractor #GNUNET_YES to not run libextractor on files (only
+ * build a tree)
* @param ex if not NULL, must be a list of extra plugins for extractor
* @param cb the callback to call when there are scanning progress messages
* @param cb_cls closure for @a cb
}
#endif
-
#endif
+
+/** @} */ /* end of group */
projects / oweals / gnunet.git / blobdiff