Help us improve by taking our short survey: https://www.hdfgroup.org/website-survey/

| HDF5 Last Updated on 2026-07-28 The HDF5 Field Guide

Loading...
Searching...
No Matches
H5FDros3.h File Reference
`#include "H5FDpublic.h"`

## Data Structures
struct | H5FD_ros3_fapl_t
| Configuration structure for H5Pset_fapl_ros3() / H5Pget_fapl_ros3(). More...

## Macros
#define | H5FD_CURR_ROS3_FAPL_T_VERSION 1
#define | H5FD_ROS3 (H5OPEN H5FD_ROS3_id_g)
#define | H5FD_ROS3_MAX_REGION_LEN 32
#define | H5FD_ROS3_MAX_SECRET_ID_LEN 128
#define | H5FD_ROS3_MAX_SECRET_KEY_LEN 128
#define | H5FD_ROS3_MAX_SECRET_TOK_LEN 4096
#define | H5FD_ROS3_VALUE H5_VFD_ROS3
#define | H5FD_ROS3_VFD_DEFAULT_LOG_FILE "hdf5_ros3_vfd.log"
#define | HDF5_ROS3_VFD_DEBUG "HDF5_ROS3_VFD_DEBUG"
#define | HDF5_ROS3_VFD_DEFAULT_BLOCK_CACHE_SIZE 134217728
#define | HDF5_ROS3_VFD_DEFAULT_BLOCK_SIZE 16777216
#define | HDF5_ROS3_VFD_FORCE_PATH_STYLE "HDF5_ROS3_VFD_FORCE_PATH_STYLE"
#define | HDF5_ROS3_VFD_LOG_FILE "HDF5_ROS3_VFD_LOG_FILE"
#define | HDF5_ROS3_VFD_LOG_LEVEL "HDF5_ROS3_VFD_LOG_LEVEL"

## Functions
herr_t | H5Pget_fapl_ros3 (hid_t fapl_id, H5FD_ros3_fapl_t *fa_out)
| Queries a File Access Property List for H5FD_ROS3 file driver properties.
herr_t | H5Pget_fapl_ros3_block_caching (hid_t fapl_id, size_t *block_size, size_t *block_cache_size, bool *lock_superblock)
| Queries a File Access Property List for H5FD_ROS3 I/O block caching parameters.
herr_t | H5Pget_fapl_ros3_endpoint (hid_t fapl_id, size_t size, char *endpoint)
| Queries a File Access Property List for H5FD_ROS3 file driver endpoint url.
herr_t | H5Pget_fapl_ros3_token (hid_t fapl_id, size_t size, char *token)
| Queries a File Access Property List for H5FD_ROS3 file driver session/security token.
herr_t | H5Pset_fapl_ros3 (hid_t fapl_id, const H5FD_ros3_fapl_t *fa)
| Modifies the specified File Access Property List to use the H5FD_ROS3 driver.
herr_t | H5Pset_fapl_ros3_block_caching (hid_t fapl_id, size_t block_size, size_t block_cache_size, bool lock_superblock)
| Modifies the specified File Access Property List to set I/O block caching parameters for the H5FD_ROS3 driver.
herr_t | H5Pset_fapl_ros3_endpoint (hid_t fapl_id, const char *endpoint)
| Modifies the specified File Access Property List to use an alternative endpoint URL when opening files with the H5FD_ROS3 driver.
herr_t | H5Pset_fapl_ros3_token (hid_t fapl_id, const char *token)
| Modifies the specified File Access Property List to use the H5FD_ROS3 driver by adding the specified session/security token.

## Macro Definition Documentation

## ◆ H5FD_CURR_ROS3_FAPL_T_VERSION

#define H5FD_CURR_ROS3_FAPL_T_VERSION 1

The version number of the H5FD_ros3_fapl_t configuration structure for the H5FD_ROS3 driver.

## ◆ H5FD_ROS3

#define H5FD_ROS3 (H5OPEN H5FD_ROS3_id_g)

Initializer for the ros3 VFD

Since
  1.8.22

## ◆ H5FD_ROS3_MAX_REGION_LEN

#define H5FD_ROS3_MAX_REGION_LEN 32

Maximum string length for specifying the region of the S3 bucket.

Since
  1.10.6

## ◆ H5FD_ROS3_MAX_SECRET_ID_LEN

#define H5FD_ROS3_MAX_SECRET_ID_LEN 128

Maximum string length for specifying the security ID.

Since
  1.10.6

## ◆ H5FD_ROS3_MAX_SECRET_KEY_LEN

#define H5FD_ROS3_MAX_SECRET_KEY_LEN 128

Maximum string length for specifying the security key.

Since
  1.10.6

## ◆ H5FD_ROS3_MAX_SECRET_TOK_LEN

#define H5FD_ROS3_MAX_SECRET_TOK_LEN 4096

Maximum string length for specifying the session/security token.

## ◆ H5FD_ROS3_VALUE

#define H5FD_ROS3_VALUE H5_VFD_ROS3

Identifier for the ros3 VFD

Since
  1.14.0

## ◆ H5FD_ROS3_VFD_DEFAULT_LOG_FILE

#define H5FD_ROS3_VFD_DEFAULT_LOG_FILE "hdf5_ros3_vfd.log"

The default filename of the file that logging output is written to when enabled. This filename can be overridden with the HDF5_ROS3_VFD_LOG_FILE environment variable.

Since
  2.0.0

## ◆ HDF5_ROS3_VFD_DEBUG

#define HDF5_ROS3_VFD_DEBUG "HDF5_ROS3_VFD_DEBUG"

Macro for name of the environment variable that specifies debugging output should be enabled for the ROS3 VFD. This output includes brief details about operations that the VFD is performing. Debugging output will be enabled if this environment variable is defined to anything other than one of (case-insensitive):

'false'
'off'
'0'

Debugging output will be printed to stderr.

Since
  2.0.0

## ◆ HDF5_ROS3_VFD_DEFAULT_BLOCK_CACHE_SIZE

#define HDF5_ROS3_VFD_DEFAULT_BLOCK_CACHE_SIZE 134217728

The default size, in bytes, of the H5FD_ROS3 driver's I/O block cache. By default, the H5FD_ROS3 driver tries to reduce requests to S3 by performing I/O in fixed-size blocks and caching these blocks in an I/O block cache. This value may be specified for the `block_cache_size` parameter to H5Pset_fapl_ros3_block_caching() in order to set the default I/O block cache size.

Since
  2.2.0

## ◆ HDF5_ROS3_VFD_DEFAULT_BLOCK_SIZE

#define HDF5_ROS3_VFD_DEFAULT_BLOCK_SIZE 16777216

The default size, in bytes, of a cached I/O block. By default, the H5FD_ROS3 driver tries to reduce requests to S3 by performing I/O in fixed-size blocks and caching these blocks in an I/O block cache. This value may be specified for the `block_size` parameter to H5Pset_fapl_ros3_block_caching() in order to set the default I/O block size.

Since
  2.2.0

## ◆ HDF5_ROS3_VFD_FORCE_PATH_STYLE

#define HDF5_ROS3_VFD_FORCE_PATH_STYLE "HDF5_ROS3_VFD_FORCE_PATH_STYLE"

Macro for name of the environment variable that forces the VFD to use path-style requests rather than virtual-hosted-style requests. The VFD attempts to use virtual-hosted-style requests by default when possible, but in some cases it may be necessary to force it to use path-style requests for compatibility reasons. The VFD will use path-style requests if this environment variable is defined to anything other than one of (case-insensitive):

'false'
'off'
'0'

Since
  2.0.0

## ◆ HDF5_ROS3_VFD_LOG_FILE

#define HDF5_ROS3_VFD_LOG_FILE "HDF5_ROS3_VFD_LOG_FILE"

Macro for name of the environment variable that specifies the filename to write logging output to when it is enabled. This environment variable may be specified as one of the values 'stderr' or 'stdout' to write output to those standard streams. Otherwise, the value is treated as a regular filename. Used in conjunction with HDF5_ROS3_VFD_LOG_LEVEL.

Since
  2.0.0

## ◆ HDF5_ROS3_VFD_LOG_LEVEL

#define HDF5_ROS3_VFD_LOG_LEVEL "HDF5_ROS3_VFD_LOG_LEVEL"

Macro for name of the environment variable that specifies whether logging output should be enabled for the ROS3 VFD. This environment variable should be specified as one of (case-insensitive):

'error'
'info'
'debug'
'trace'

If specified as one of these values, logging output will be written to the file specified by the HDF5_ROS3_VFD_LOG_FILE environment variable. If that environment variable is not specified, logging will be written to the default file specified by H5FD_ROS3_VFD_DEFAULT_LOG_FILE.

Note that this logging output is separate from and much more detailed than the debugging information enabled by the HDF5_ROS3_VFD_DEBUG environment variable.

Since
  2.0.0