source/include/H5VLpassthru.h

0001 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
0002  * Copyright by The HDF Group.                                               *
0003  * All rights reserved.                                                      *
0004  *                                                                           *
0005  * This file is part of HDF5.  The full HDF5 copyright notice, including     *
0006  * terms governing use, modification, and redistribution, is contained in    *
0007  * the COPYING file, which can be found at the root of the source code       *
0008  * distribution tree, or in https://www.hdfgroup.org/licenses.               *
0009  * If you do not have access to either file, you may request a copy from     *
0010  * help@hdfgroup.org.                                                        *
0011  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
0012
0013 /*
0014  * Purpose: The public header file for the pass-through VOL connector.
0015  */
0016
0017 #ifndef H5VLpassthru_H
0018 #define H5VLpassthru_H
0019
0020 /* Public headers needed by this file */
0021 #include "H5VLpublic.h" /* Virtual Object Layer                 */
0022
0023 /* Identifier for the pass-through VOL connector */
0024 #define H5VL_PASSTHRU (H5VL_pass_through_register())
0025
0026 /* Characteristics of the pass-through VOL connector */
0027 #define H5VL_PASSTHRU_NAME    "pass_through"
0028 #define H5VL_PASSTHRU_VALUE   1 /* VOL connector ID */
0029 #define H5VL_PASSTHRU_VERSION 0
0030
0031 /* Pass-through VOL connector info */
0032 typedef struct H5VL_pass_through_info_t {
0033     hid_t under_vol_id;   /* VOL ID for under VOL */
0034     void *under_vol_info; /* VOL info for under VOL */
0035 } H5VL_pass_through_info_t;
0036
0037 #ifdef __cplusplus
0038 extern "C" {
0039 #endif
0040
0041 H5_DLL hid_t H5VL_pass_through_register(void);
0042
0043 #ifdef __cplusplus
0044 }
0045 #endif
0046
0047 #endif /* H5VLpassthru_H */