dos2unix
[oweals/gnunet.git] / src / util / disk.h
1 /*
2      This file is part of GNUnet.
3      (C) 2009 Christian Grothoff (and other contributing authors)
4
5      GNUnet is free software; you can redistribute it and/or modify
6      it under the terms of the GNU General Public License as published
7      by the Free Software Foundation; either version 2, or (at your
8      option) any later version.
9
10      GNUnet is distributed in the hope that it will be useful, but
11      WITHOUT ANY WARRANTY; without even the implied warranty of
12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13      General Public License for more details.
14
15      You should have received a copy of the GNU General Public License
16      along with GNUnet; see the file COPYING.  If not, write to the
17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18      Boston, MA 02111-1307, USA.
19 */  
20   
21 /**
22  * @file util/disk.h
23  * @brief Internal DISK related helper functions
24  * @author Nils Durner
25  */ 
26   \r
27 #ifndef GNUNET_DISK_H_
28 #define GNUNET_DISK_H_
29   
30 #include "gnunet_disk_lib.h"
31   \r
32 /**
33  * Handle used to access files (and pipes).  
34  */ 
35 struct GNUNET_DISK_FileHandle 
36 {
37   
38 #ifdef MINGW
39   /**
40    * File handle under W32.
41    */ 
42   HANDLE h;
43
44   /**
45    * Type
46    */
47   enum {GNUNET_DISK_FILE, GNUNET_PIPE} type;
48
49   /**
50    * Structure for overlapped reading (for pipes)
51    */
52   OVERLAPPED *oOverlapRead;
53
54   /**
55    * Structure for overlapped writing (for pipes)
56    */
57   OVERLAPPED *oOverlapWrite;
58 #else
59
60   /**
61    * File handle on other OSes.
62    */ 
63   int fd;
64    
65 #endif                          /* \r */
66 };
67 \r\r\r
68 /**
69  * Retrieve OS file handle
70  *
71  * @internal
72  * @param fh GNUnet file descriptor
73  * @param dst destination buffer
74  * @param dst_len length of dst
75  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
76  */ 
77 int GNUNET_DISK_internal_file_handle_ (const struct GNUNET_DISK_FileHandle
78                                        *fh, \rvoid *dst, \rsize_t dst_len);
79 \r
80 #endif  /* GNUNET_DISK_H_ */