HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
H5FDdirect.h
Go to the documentation of this file.
1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
2  * Copyright by The HDF Group. *
3  * Copyright by the Board of Trustees of the University of Illinois. *
4  * All rights reserved. *
5  * *
6  * This file is part of HDF5. The full HDF5 copyright notice, including *
7  * terms governing use, modification, and redistribution, is contained in *
8  * the files COPYING and Copyright.html. COPYING can be found at the root *
9  * of the source code distribution tree; Copyright.html can be found at the *
10  * root level of an installed copy of the electronic HDF5 document set and *
11  * is linked from the top-level documents page. It can also be found at *
12  * http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *
13  * access to either file, you may request a copy from help@hdfgroup.org. *
14  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /*
17  * Programmer: Raymond Lu <slu@hdfgroup.uiuc.edu>
18  * Wednesday, 20 September 2006
19  *
20  * Purpose: The public header file for the direct driver.
21  */
22 #ifndef H5FDdirect_H
23 #define H5FDdirect_H
24 
25 #include "H5Ipublic.h"
26 
27 #ifdef H5_HAVE_DIRECT
28 # define H5FD_DIRECT (H5FD_direct_init())
29 #else
30 # define H5FD_DIRECT (-1)
31 #endif /* H5_HAVE_DIRECT */
32 
33 #ifdef H5_HAVE_DIRECT
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
38 /* Default values for memory boundary, file block size, and maximal copy buffer size.
39  * Application can set these values through the function H5Pset_fapl_direct. */
40 #define MBOUNDARY_DEF 4096
41 #define FBSIZE_DEF 4096
42 #define CBSIZE_DEF 16*1024*1024
43 
44 H5_DLL hid_t H5FD_direct_init(void);
45 H5_DLL void H5FD_direct_term(void);
46 H5_DLL herr_t H5Pset_fapl_direct(hid_t fapl_id, size_t alignment, size_t block_size,
47  size_t cbuf_size);
48 H5_DLL herr_t H5Pget_fapl_direct(hid_t fapl_id, size_t *boundary/*out*/,
49  size_t *block_size/*out*/, size_t *cbuf_size/*out*/);
50 
51 #ifdef __cplusplus
52 }
53 #endif
54 
55 #endif /* H5_HAVE_DIRECT */
56 
57 #endif
#define H5_DLL
Definition: H5api_adpt.h:406
int herr_t
Definition: H5public.h:107
int hid_t
Definition: H5Ipublic.h:56