Page tree

The license could not be verified: License Certificate has expired!

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Content Layer
id1195548671
Content Column
width50.00001%
id1195578110
classrm_pagetree_col mobile-hide
Content Block
id1195578111
 
Content Column
width50.00001%
id1195548673
classhdf-rm-main-column
Content Block
id1195548672

Include Content
render-without-blockstrue
page.rm-navbar
HTML Wrap
classhdf-print-only

Page Title

HTML Wrap
classhdf-rm-summary-block

Hdf rm anchor
AnchorNamesummary

Excerpt

Sets up Read-Only S3 virtual file driver (coming soon)

HTML Wrap
classhdf-rm-content-block

Hdf rm anchor
AnchorNameprocedure

Procedure:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf_procedure

H5P_SET_FAPL_ROS3 (fapl_id, fa)

Hdf rm anchor
AnchorNamesignature

Signature:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf-togglebox hdf-c

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-c

HTML
<pre><code class="language-c">herr_t H5Pset_fapl_ros3(hid_t fapl_id, H5FD_ros3_fapl_t *fa)
  </code></pre>
Comment (Hide)
HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-fortran

HTML
<pre><code class="language-fortran">
    </code></pre>

Hdf rm anchor
AnchorNameparameters

Parameters:
HTML Wrap
classhdf-rm-section

hid_t fapl_id                IN: File access property list identifier

H5FD_ros3_fapl_t *fa       IN: Structure containing fapl configuration information

Hdf rm anchor
AnchorNamedescription

Description:
HTML Wrap
classhdf-rm-section

H5P_SET_FAPL_ROS3 sets the file access property list fapl_id to use the ROS3 file driver.

The Read-Only S3 virtual file driver transparently accesses HDF5-format files hosted remotely on Amazon's Simple Storage Service (S3). It supplies bytes transparently to the HDF5 library through the AWS REST API.

In addition to requiring very different underlying operation, files on S3 may have restricted access, requiring that attempts to access and read provide "credentials" to authenticate the recipient and message integrity. The structure H5FD_ros3_fapl_t contains a flag to indicate whether or not this authentication is to take place, as well as to supply credentials to the virtual file driver.

If the configuration structure is set to not authenticate, e.g., fa.authenticate == (hbool_t)FALSE, then the credential fields aws_region, secret_id, and secret_key are ignored.

If the configuration structure is set to authenticate, e.g.,fa.authenticate== (hbool_t)TRUE, then the credential fields must be populated with null-terminated strings. Each component is an array of characters, the size of which is determined by a constant in H5FDros3.c, e.g., H5FD__ROS3_MAX_REGION_LEN. If the string exceeds the defined length, an error has likely occurred and behavior is undefined.

Hdf rm anchor
AnchorNamereturns

Returns:
HTML Wrap
classhdf-rm-section

Non-negative value if successful. Otherwise returns negative value.

Hdf rm anchor
AnchorNameexample

Example:
HTML Wrap
classhdf-rm-section
   hid_t fapl_id = -1;
    /* default, non-authenticating, "anonymous" fapl configuration */
    H5FD_ros3_fapl_t fa = { 1, 0, "", "", "" };
 
    #if AUTHENTICATE_STATIC_VARS
 
    /* fapl with authentication credentials provided statically */
    fa = { 1,                                         /* version             */
           1,                                         /* authenticate        */
           "us-east-2",                               /* aws_region          */
           "AKIAIMC3D3XLYXLN5COA",                    /* access_key_id       */
           "ugs5aVVnLFCErO/8uW14iWE3K5AgXMpsMlWneO/+" /* secret_access_key   */
    };
 
    #elif AUTHENTICATE_DYNAMIC_VARS
 
    /* fapl populated dynamically
    /* Assumes variables `should_authenticate`, `the_region`,
     * `the_access_key_id`, and `the_secret_access_key` have been set somewhere
     */
    fa.authenticate = should_authenticate; /* 0 (FALSE) or 1 (TRUE) */
    strncpy(fa.aws_region, the_region, H5FD__ROS3_MAX_REGION_LEN);
    strncpy(fa.secret_id, the_access_key_id, H5FD__ROS3_MAX_SECRET_ID_LEN);
    strncpy(fa.secret_key, the_secret_access_key,
            H5FD__ROS3_MAX_SECRET_KEY_LEN);
 
    #endif /* set authenticating fapl info statically or dynamically */
 
    /* create and set fapl entry */
    fapl_id = H5Pcreate(H5P_FILE_ACCESS);
    assert( 0 >= fapl_id );
    assert( 0 >= H5Pset_fapl_ros3(fapl_id, &fa) );
 

 

Comment (Hide)
HTML Wrap
classhdf-togglebox hdf-c

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathexamples/h5_subset.c
showLineNumberstrue
lineStart32
progLangcpp
lineEnd42
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathfortran/examples/compound.f90
showLineNumberstrue
lineStart25
progLangplain
lineEnd35
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

Hdf rm anchor
AnchorNamehistory

History:
HTML Wrap
classhdf-rm-section
Release    Change
1.12.10C function introduced in this release.