multicast: removed replay cancellation as responses are limited
[oweals/gnunet.git] / src / include / gnunet_disk_lib.h
index 369f09492a67f95ec63cf329f04c8e2b8b8c8318..4b38a31d610286a630db1ddb5056dcd5a5265acf 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2001-2012 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2001-2012 Christian Grothoff (and other contributing authors)
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -14,8 +14,8 @@
 
      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_disk_lib.h
 #ifndef GNUNET_DISK_LIB_H
 #define GNUNET_DISK_LIB_H
 
-#if WINDOWS
-#define OFF_T uint64_t
-#else
-#define OFF_T off_t
-#endif
-
 /**
  * Handle used to manage a pipe.
  */
@@ -41,6 +35,11 @@ struct GNUNET_DISK_PipeHandle;
  */
 enum GNUNET_FILE_Type
 {
+  /**
+   * Handle represents an event.
+   */
+  GNUNET_DISK_HANLDE_TYPE_EVENT,
+
   /**
    * Handle represents a file.
    */
@@ -271,7 +270,7 @@ enum GNUNET_DISK_PipeEnd
  * Checks whether a handle is invalid
  *
  * @param h handle to check
- * @return GNUNET_YES if invalid, GNUNET_NO if valid
+ * @return #GNUNET_YES if invalid, #GNUNET_NO if valid
  */
 int
 GNUNET_DISK_handle_invalid (const struct GNUNET_DISK_FileHandle *h);
@@ -307,8 +306,8 @@ GNUNET_DISK_file_backup (const char *fil);
  * @param whence specification to which position the offset parameter relates to
  * @return the new position on success, GNUNET_SYSERR otherwise
  */
-OFF_T
-GNUNET_DISK_file_seek (const struct GNUNET_DISK_FileHandle *h, OFF_T offset,
+off_t
+GNUNET_DISK_file_seek (const struct GNUNET_DISK_FileHandle *h, off_t offset,
                        enum GNUNET_DISK_Seek whence);
 
 
@@ -345,7 +344,7 @@ GNUNET_DISK_file_size (const char *filename, uint64_t *size,
  * @param filename name of the file
  * @param dev set to the device ID
  * @param ino set to the inode ID
- * @return GNUNET_OK on success
+ * @return #GNUNET_OK on success
  */
 int
 GNUNET_DISK_file_get_identifiers (const char *filename,
@@ -408,7 +407,7 @@ GNUNET_DISK_file_open (const char *fn,
  */
 int
 GNUNET_DISK_file_handle_size (struct GNUNET_DISK_FileHandle *fh,
-                             OFF_T *size);
+                             off_t *size);
 
 
 /**
@@ -514,6 +513,20 @@ struct GNUNET_DISK_FileHandle *
 GNUNET_DISK_get_handle_from_w32_handle (HANDLE osfh);
 #endif
 
+/**
+ * Update POSIX permissions mask of a file on disk.  If both argumets
+ * are #GNUNET_NO, the file is made world-read-write-executable (777).
+ * Does nothing on W32.
+ *
+ * @param fn name of the file to update
+ * @param require_uid_match #GNUNET_YES means 700
+ * @param require_gid_match #GNUNET_YES means 770 unless @a require_uid_match is set
+ */
+void
+GNUNET_DISK_fix_permissions (const char *fn,
+                             int require_uid_match,
+                             int require_gid_match);
+
 
 /**
  * Get a handle from a native integer FD.
@@ -632,7 +645,8 @@ GNUNET_DISK_fn_write (const char *fn,
  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
  */
 int
-GNUNET_DISK_file_copy (const char *src, const char *dst);
+GNUNET_DISK_file_copy (const char *src,
+                       const char *dst);
 
 
 /**
@@ -665,10 +679,11 @@ struct GNUNET_DISK_DirectoryIterator;
  * @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);
+typedef void
+(*GNUNET_DISK_DirectoryIteratorCallback) (void *cls,
+                                          struct GNUNET_DISK_DirectoryIterator *di,
+                                          const char *filename,
+                                          const char *dirname);
 
 
 /**
@@ -767,8 +782,8 @@ GNUNET_DISK_directory_create (const char *dir);
  */
 int
 GNUNET_DISK_file_lock (struct GNUNET_DISK_FileHandle *fh,
-                       OFF_T lock_start,
-                       OFF_T lock_end, int excl);
+                       off_t lock_start,
+                       off_t lock_end, int excl);
 
 
 /**
@@ -781,8 +796,8 @@ GNUNET_DISK_file_lock (struct GNUNET_DISK_FileHandle *fh,
  */
 int
 GNUNET_DISK_file_unlock (struct GNUNET_DISK_FileHandle *fh,
-                         OFF_T unlock_start,
-                         OFF_T unlock_end);
+                         off_t unlock_start,
+                         off_t unlock_end);
 
 
 /**
@@ -803,25 +818,6 @@ int
 GNUNET_DISK_file_change_owner (const char *filename, const char *user);
 
 
-/**
- * Construct full path to a file inside of the private
- * directory used by GNUnet.  Also creates the corresponding
- * directory.  If the resulting name is supposed to be
- * a directory, end the last argument in '/' (or pass
- * DIR_SEPARATOR_STR as the last argument before NULL).
- *
- * @param cfg configuration to use
- * @param service_name name of the service asking
- * @param ... is NULL-terminated list of
- *                path components to append to the
- *                private directory name.
- * @return the constructed filename
- */
-char *
-GNUNET_DISK_get_home_filename (const struct GNUNET_CONFIGURATION_Handle *cfg,
-                               const char *service_name, ...);
-
-
 /**
  * Opaque handle for a memory-mapping operation.
  */