/*
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
- by the Free Software Foundation; either version 3, or (at your
- option) any later version.
+ GNUnet is free software: you can redistribute it and/or modify it
+ under the terms of the GNU Affero General Public License as published
+ by the Free Software Foundation, either version 3 of the License,
+ 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.
+ Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
- * @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
*
* @param uri uri to convert to a unique key
* @param key wherer to store the unique key
+ * @return #GNUNET_OK on success
*/
-void
+int
GNUNET_FS_uri_to_key (const struct GNUNET_FS_Uri *uri,
struct GNUNET_HashCode *key);
/* ******************** command-line option parsing API *********************** */
/**
- * Command-line option parser function that allows the user
- * to specify one or more '-k' options with keywords. Each
- * specified keyword will be added to the URI. A pointer to
- * the URI must be passed as the "scls" argument.
+ * Allow user to specify keywords.
*
- * @param ctx command line processor context
- * @param scls must be of type "struct GNUNET_FS_Uri **"
- * @param option name of the option (typically 'k')
- * @param value command line argument given
- * @return #GNUNET_OK on success
+ * @param shortName short name of the option
+ * @param name long name of the option
+ * @param argumentHelp help text for the option argument
+ * @param description long help text for the option
+ * @param[out] topKeywords set to the desired value
*/
-int
-GNUNET_FS_getopt_set_keywords (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx,
- void *scls,
- const char *option,
- const char *value);
+struct GNUNET_GETOPT_CommandLineOption
+GNUNET_FS_GETOPT_KEYWORDS (char shortName,
+ const char *name,
+ const char *argumentHelp,
+ const char *description,
+ struct GNUNET_FS_Uri **topKeywords);
+/**
+ * Allow user to specify metadata.
+ *
+ * @param shortName short name of the option
+ * @param name long name of the option
+ * @param argumentHelp help text for the option argument
+ * @param description long help text for the option
+ * @param[out] metadata set to the desired value
+ */
+struct GNUNET_GETOPT_CommandLineOption
+GNUNET_FS_GETOPT_METADATA (char shortName,
+ const char *name,
+ const char *argumentHelp,
+ const char *description,
+ struct GNUNET_CONTAINER_MetaData **meta);
/**
* Command-line option parser function that allows the user to specify
* 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);
/**
* @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);
/**
/**
- * 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