convert fs publish to MQ

[oweals/gnunet.git] / src / include / gnunet_fs_service.h

diff --git a/src/include/gnunet_fs_service.h b/src/include/gnunet_fs_service.h
index f9c56db641cea19464a0bf0c21c5a9c24cbd8feb..a9c7e894446b1c03a5f1400ca89207c7ec2bc01c 100644 (file)
--- a/src/include/gnunet_fs_service.h
+++ b/src/include/gnunet_fs_service.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet
-     Copyright (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
@@ -18,9 +18,17 @@
      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
@@ -1582,8 +1590,9 @@ struct GNUNET_FS_ProgressInfo
  *         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);
 
 
 /**
@@ -1703,9 +1712,9 @@ struct GNUNET_FS_Handle;
  */
 struct GNUNET_FS_Handle *
 GNUNET_FS_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
-                 const char *client_name, 
+                 const char *client_name,
                 GNUNET_FS_ProgressCallback upcb,
-                 void *upcb_cls, 
+                 void *upcb_cls,
                 enum GNUNET_FS_Flags flags,
                 ...);
 
@@ -1738,17 +1747,15 @@ 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);
 
 
 /**
@@ -1805,13 +1812,10 @@ struct GNUNET_FS_FileInformation *
 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);
 
 
 /**
@@ -1832,15 +1836,13 @@ GNUNET_FS_file_information_create_from_file (struct GNUNET_FS_Handle *h,
  */
 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);
 
 
 /**
@@ -1863,8 +1865,12 @@ GNUNET_FS_file_information_create_from_data (struct GNUNET_FS_Handle *h,
  * @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);
 
 
 /**
@@ -2047,9 +2053,10 @@ GNUNET_FS_publish_stop (struct GNUNET_FS_PublishContext *pc);
  * @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);
 
 
 /**
@@ -2140,8 +2147,10 @@ GNUNET_FS_publish_sks_cancel (struct GNUNET_FS_PublishSksContext *psc);
  * @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);
 
 
 /**
@@ -2745,7 +2754,7 @@ struct GNUNET_FS_ShareTreeItem
 
 
 /**
- * Opaqe handle to an asynchronous directory scanning activity.
+ * Opaque handle to an asynchronous directory scanning activity.
  */
 struct GNUNET_FS_DirScanner;
 
@@ -2754,7 +2763,8 @@ 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
@@ -2816,5 +2826,6 @@ GNUNET_FS_share_tree_free (struct GNUNET_FS_ShareTreeItem *toplevel);
 }
 #endif
 
-
 #endif
+
+/** @} */  /* end of group */