summaryrefslogtreecommitdiffstats
path: root/src/H5FDsubfiling.h
blob: b4b3f1cf3f0c3ce74a3a1ad858558e8dc52da376 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Copyright by The HDF Group.                                               *
 * Copyright by the Board of Trustees of the University of Illinois.         *
 * All rights reserved.                                                      *
 *                                                                           *
 * This file is part of HDF5.  The full HDF5 copyright notice, including     *
 * terms governing use, modification, and redistribution, is contained in    *
 * the COPYING file, which can be found at the root of the source code       *
 * distribution tree, or in https://support.hdfgroup.org/ftp/HDF5/releases.  *
 * If you do not have access to either file, you may request a copy from     *
 * help@hdfgroup.org.                                                        *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/*
 * Programmer:  Robb Matzke <matzke@llnl.gov>
 *              Monday, August  2, 1999
 *
 * Purpose:	The public header file for the subfiling driver.
 */
#ifndef H5FDsubfiling_H
#define H5FDsubfiling_H

#define H5FD_SUBFILING	(H5FD_subfiling_init())

/****************************************************************************
 *
 * Structure: H5FD_subfiling_fapl_t
 *
 * Purpose:
 *
 *     H5FD_subfiling_fapl_t is a public structure that is used to pass 
 *     subfiling configuration data to the appropriate subfiling VFD via 
 *     the FAPL.  A pointer to an instance of this structure is a parameter 
 *     to H5Pset_fapl_subfiling() and H5Pget_fapl_subfiling().
 *
 * `version` (int32_t)
 *
 *     Version number of the H5FD_subfiling_fapl_t structure.  Any instance 
 *     passed to the above calls must have a recognized version number, or 
 *     an error will be flagged.
 *
 *     This field should be set to H5FD_CURR_SUBFILING_FAPL_T_VERSION.
 *
 *
 *     Add fields needed to configure the subfiling VFD here.
 *
 *     Note that we have to be able to copy FAPL entries -- thus use of 
 *     variable size fields (i.e. pointers to strings, etc) will complicate
 *     matters.
 *
 ****************************************************************************/

#define H5FD_CURR_SUBFILING_FAPL_T_VERSION     1

typedef struct H5FD_subfiling_fapl_t {

    int32_t version;

    /* add configuration fields here */
    
} H5FD_subfiling_fapl_t;


#ifdef __cplusplus
extern "C" {
#endif

H5_DLL hid_t H5FD_subfiling_init(void);
H5_DLL herr_t H5Pget_fapl_subfiling(hid_t fapl_id, 
    H5FD_subfiling_fapl_t *fa_out);
H5_DLL herr_t H5Pset_fapl_subfiling(hid_t fapl_id,  H5FD_subfiling_fapl_t *fa);

#ifdef __cplusplus
}
#endif

#endif