Files
hdf5/develop/_h5_a_cpublic_8h.html
T
2026-09-24 01:29:34 +00:00

280 lines
14 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.16.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: src/H5ACpublic.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="hdf5doxy.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Help us improve by taking our short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
<!-- ... other metadata & script includes ... -->
<script type="text/javascript" src="doxygen-awesome-tabs.js"></script>
<script type="text/javascript">
DoxygenAwesomeTabs.init()
</script>
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-57FMZK4S7X"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-57FMZK4S7X');
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
<td id="projectalign">
<div id="projectname">HDF5<span id="projectnumber">&#160;Last Updated on 2026-09-24</span>
</div>
<div id="projectbrief">The HDF5 Field Guide</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.16.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<div id="main-nav">
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="_getting_started.html"><span>Getting&#160;started</span></a></li>
<li><a href="_u_g.html"><span>User&#160;Guide</span></a></li>
<li><a href="_r_m.html"><span>Reference&#160;Manual</span></a></li>
<li><a href="_cookbook.html"><span>Cookbook</span></a></li>
<li><a href="_t_n.html"><span>Technical&#160;Notes</span></a></li>
<li><a href="_r_f_c.html"><span>RFCs</span></a></li>
<li><a href="_s_p_e_c.html"><span>Specifications</span></a></li>
<li><a href="_g_l_s.html"><span>Glossary</span></a></li>
<li><a href="_f_t_s.html"><span>Full-Text&#160;Search</span></a></li>
<li><a href="_about.html"><span>About</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" class="search-icon" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"><span class="search-icon-dropdown"></span></span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- main-nav -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('_h5_a_cpublic_8h.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">H5ACpublic.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="_h5public_8h.html">H5public.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_h5_cpublic_8h.html">H5Cpublic.h</a>&quot;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-nested-classes" class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:H5AC_5Fcache_5Fconfig_5Ft" id="r_H5AC_5Fcache_5Fconfig_5Ft"><td class="memItemLeft">struct &#160;</td><td class="memItemRight"><a class="el" href="struct_h5_a_c__cache__config__t.html">H5AC_cache_config_t</a></td></tr>
<tr class="memitem:H5AC_5Fcache_5Fimage_5Fconfig_5Ft" id="r_H5AC_5Fcache_5Fimage_5Fconfig_5Ft"><td class="memItemLeft">struct &#160;</td><td class="memItemRight"><a class="el" href="struct_h5_a_c__cache__image__config__t.html">H5AC_cache_image_config_t</a></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-define-members" class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:aa1f7f6392005e5678f609043d644512b" id="r_aa1f7f6392005e5678f609043d644512b"><td class="memItemLeft">#define&#160;</td><td class="memItemRight"><a class="el" href="#aa1f7f6392005e5678f609043d644512b">H5AC__CACHE_IMAGE__ENTRY_AGEOUT__MAX</a>&#160;&#160;&#160;100</td></tr>
<tr class="memitem:a4d2023e273e0cdda3c350e4de91baf78" id="r_a4d2023e273e0cdda3c350e4de91baf78"><td class="memItemLeft">#define&#160;</td><td class="memItemRight"><a class="el" href="#a4d2023e273e0cdda3c350e4de91baf78">H5AC__CACHE_IMAGE__ENTRY_AGEOUT__NONE</a>&#160;&#160;&#160;-1</td></tr>
<tr class="memitem:a3f9ce24b57f5ff1b5a1a301f47f89799" id="r_a3f9ce24b57f5ff1b5a1a301f47f89799"><td class="memItemLeft">#define&#160;</td><td class="memItemRight"><a class="el" href="#a3f9ce24b57f5ff1b5a1a301f47f89799">H5AC__CURR_CACHE_CONFIG_VERSION</a>&#160;&#160;&#160;1</td></tr>
<tr class="memitem:a2456b36b5c16ebe3de021513544bb1cf" id="r_a2456b36b5c16ebe3de021513544bb1cf"><td class="memItemLeft">#define&#160;</td><td class="memItemRight"><a class="el" href="#a2456b36b5c16ebe3de021513544bb1cf">H5AC__CURR_CACHE_IMAGE_CONFIG_VERSION</a>&#160;&#160;&#160;1</td></tr>
<tr class="memitem:a717f1f3545cfc3d1b2208c96cc0c3bd3" id="r_a717f1f3545cfc3d1b2208c96cc0c3bd3"><td class="memItemLeft">#define&#160;</td><td class="memItemRight"><a class="el" href="#a717f1f3545cfc3d1b2208c96cc0c3bd3">H5AC__MAX_TRACE_FILE_NAME_LEN</a>&#160;&#160;&#160;1024</td></tr>
<tr class="memitem:af7cea0f4927dfafa3017a34e2b84cce3" id="r_af7cea0f4927dfafa3017a34e2b84cce3"><td class="memItemLeft">#define&#160;</td><td class="memItemRight"><a class="el" href="#af7cea0f4927dfafa3017a34e2b84cce3">H5AC_METADATA_WRITE_STRATEGY__DISTRIBUTED</a>&#160;&#160;&#160;1</td></tr>
<tr class="memitem:a5ef1a23a562608db819d7e805f490404" id="r_a5ef1a23a562608db819d7e805f490404"><td class="memItemLeft">#define&#160;</td><td class="memItemRight"><a class="el" href="#a5ef1a23a562608db819d7e805f490404">H5AC_METADATA_WRITE_STRATEGY__PROCESS_0_ONLY</a>&#160;&#160;&#160;0</td></tr>
</table>
<a name="doc-define-members" id="doc-define-members"></a><h2 id="header-doc-define-members" class="groupheader">Macro Definition Documentation</h2>
<a id="aa1f7f6392005e5678f609043d644512b" name="aa1f7f6392005e5678f609043d644512b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1f7f6392005e5678f609043d644512b">&#9670;&#160;</a></span>H5AC__CACHE_IMAGE__ENTRY_AGEOUT__MAX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5AC__CACHE_IMAGE__ENTRY_AGEOUT__MAX&#160;&#160;&#160;100</td>
</tr>
</table>
</div><div class="memdoc">
<p>Limit on number of times a prefetched entry can appear in subsequent cache images </p><dl class="section since"><dt>Since</dt><dd>1.10.1 </dd></dl>
</div>
</div>
<a id="a4d2023e273e0cdda3c350e4de91baf78" name="a4d2023e273e0cdda3c350e4de91baf78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d2023e273e0cdda3c350e4de91baf78">&#9670;&#160;</a></span>H5AC__CACHE_IMAGE__ENTRY_AGEOUT__NONE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5AC__CACHE_IMAGE__ENTRY_AGEOUT__NONE&#160;&#160;&#160;-1</td>
</tr>
</table>
</div><div class="memdoc">
<p>No limit on number of times a prefetched entry can appear in subsequent cache images </p><dl class="section since"><dt>Since</dt><dd>1.10.1 </dd></dl>
</div>
</div>
<a id="a3f9ce24b57f5ff1b5a1a301f47f89799" name="a3f9ce24b57f5ff1b5a1a301f47f89799"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f9ce24b57f5ff1b5a1a301f47f89799">&#9670;&#160;</a></span>H5AC__CURR_CACHE_CONFIG_VERSION</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5AC__CURR_CACHE_CONFIG_VERSION&#160;&#160;&#160;1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Current version number of the metadata cache configuration structure </p><dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="a2456b36b5c16ebe3de021513544bb1cf" name="a2456b36b5c16ebe3de021513544bb1cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2456b36b5c16ebe3de021513544bb1cf">&#9670;&#160;</a></span>H5AC__CURR_CACHE_IMAGE_CONFIG_VERSION</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5AC__CURR_CACHE_IMAGE_CONFIG_VERSION&#160;&#160;&#160;1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Current version number of the metadata cache image configuration structure </p><dl class="section since"><dt>Since</dt><dd>1.10.1 </dd></dl>
</div>
</div>
<a id="a717f1f3545cfc3d1b2208c96cc0c3bd3" name="a717f1f3545cfc3d1b2208c96cc0c3bd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a717f1f3545cfc3d1b2208c96cc0c3bd3">&#9670;&#160;</a></span>H5AC__MAX_TRACE_FILE_NAME_LEN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5AC__MAX_TRACE_FILE_NAME_LEN&#160;&#160;&#160;1024</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum allowed length (in characters) of a metadata cache trace file name </p><dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="af7cea0f4927dfafa3017a34e2b84cce3" name="af7cea0f4927dfafa3017a34e2b84cce3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7cea0f4927dfafa3017a34e2b84cce3">&#9670;&#160;</a></span>H5AC_METADATA_WRITE_STRATEGY__DISTRIBUTED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5AC_METADATA_WRITE_STRATEGY__DISTRIBUTED&#160;&#160;&#160;1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Process 0 determines which metadata entries to flush, but the actual writes are distributed across processes at a sync point, with coordination ensuring each entry is flushed exactly once and marked clean everywhere. </p><dl class="section since"><dt>Since</dt><dd>1.8.6 </dd></dl>
</div>
</div>
<a id="a5ef1a23a562608db819d7e805f490404" name="a5ef1a23a562608db819d7e805f490404"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ef1a23a562608db819d7e805f490404">&#9670;&#160;</a></span>H5AC_METADATA_WRITE_STRATEGY__PROCESS_0_ONLY</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5AC_METADATA_WRITE_STRATEGY__PROCESS_0_ONLY&#160;&#160;&#160;0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Only process 0 performs metadata writes to disk; other processes retain dirty metadata and mark entries clean only after process 0 flushes them and broadcasts the results at a sync point. </p><dl class="section since"><dt>Since</dt><dd>1.8.6 </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a href="_h5_a_cpublic_8h.html">H5ACpublic.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
</ul>
</div>
</body>
</html>