X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_disk_lib.h;h=02c4b3674f787f9a3bd2711262a72a4f42928a92;hb=360d7afad50d1af425a20e89419d2063a6a0e220;hp=4b38a31d610286a630db1ddb5056dcd5a5265acf;hpb=07d2afe861142b47025207c1834225932ba6e690;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_disk_lib.h b/src/include/gnunet_disk_lib.h index 4b38a31d6..02c4b3674 100644 --- a/src/include/gnunet_disk_lib.h +++ b/src/include/gnunet_disk_lib.h @@ -1,6 +1,6 @@ /* This file is part of GNUnet. - Copyright (C) 2001-2012 Christian Grothoff (and other contributing authors) + Copyright (C) 2001-2012 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,14 @@ Boston, MA 02110-1301, USA. */ /** - * @file include/gnunet_disk_lib.h - * @brief disk IO apis * @author Christian Grothoff + * + * @file + * Disk IO APIs + * + * @defgroup disk Disk library + * Disk IO APIs + * @{ */ #ifndef GNUNET_DISK_LIB_H #define GNUNET_DISK_LIB_H @@ -663,65 +668,6 @@ GNUNET_DISK_directory_scan (const char *dir_name, void *callback_cls); -/** - * Opaque handle used for iterating over a directory. - */ -struct GNUNET_DISK_DirectoryIterator; - - -/** - * Function called to iterate over a directory. - * - * @param cls closure - * @param di argument to pass to #GNUNET_DISK_directory_iterator_next to - * get called on the next entry (or finish cleanly); - * NULL on error (will be the last call in that case) - * @param filename complete filename (absolute path) - * @param dirname directory name (absolute path) - */ -typedef void -(*GNUNET_DISK_DirectoryIteratorCallback) (void *cls, - struct GNUNET_DISK_DirectoryIterator *di, - const char *filename, - const char *dirname); - - -/** - * This function must be called during the DiskIteratorCallback - * (exactly once) to schedule the task to process the next - * filename in the directory (if there is one). - * - * @param iter opaque handle for the iterator - * @param can set to #GNUNET_YES to terminate the iteration early - * @return #GNUNET_YES if iteration will continue, - * #GNUNET_NO if this was the last entry (and iteration is complete), - * #GNUNET_SYSERR if @a can was #GNUNET_YES - */ -int -GNUNET_DISK_directory_iterator_next (struct GNUNET_DISK_DirectoryIterator *iter, - int can); - - -/** - * Scan a directory for files using the scheduler to run a task for - * each entry. The name of the directory must be expanded first (!). - * If a scheduler does not need to be used, GNUNET_DISK_directory_scan - * may provide a simpler API. - * - * @param prio priority to use - * @param dir_name the name of the directory - * @param callback the method to call for each file - * @param callback_cls closure for @a callback - * @return #GNUNET_YES if directory is not empty and @a callback - * will be called later, #GNUNET_NO otherwise, #GNUNET_SYSERR on error. - */ -int -GNUNET_DISK_directory_iterator_start (enum GNUNET_SCHEDULER_Priority prio, - const char *dir_name, - GNUNET_DISK_DirectoryIteratorCallback - callback, void *callback_cls); - - /** * Create the directory structure for storing * a file. @@ -815,7 +761,8 @@ GNUNET_DISK_filename_canonicalize (char *fn); * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure */ int -GNUNET_DISK_file_change_owner (const char *filename, const char *user); +GNUNET_DISK_file_change_owner (const char *filename, + const char *user); /** @@ -834,7 +781,9 @@ struct GNUNET_DISK_MapHandle; void * GNUNET_DISK_file_map (const struct GNUNET_DISK_FileHandle *h, struct GNUNET_DISK_MapHandle **m, - enum GNUNET_DISK_MapType access, size_t len); + enum GNUNET_DISK_MapType access, + size_t len); + /** * Unmap a file @@ -845,8 +794,10 @@ GNUNET_DISK_file_map (const struct GNUNET_DISK_FileHandle *h, int GNUNET_DISK_file_unmap (struct GNUNET_DISK_MapHandle *h); + /** * Write file changes to disk + * * @param h handle to an open file * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise */ @@ -861,7 +812,9 @@ GNUNET_DISK_file_sync (const struct GNUNET_DISK_FileHandle *h); } #endif - /* ifndef GNUNET_DISK_LIB_H */ #endif + +/** @} */ /* end of group */ + /* end of gnunet_disk_lib.h */