diff options
author | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-06-26 19:22:17 (GMT) |
---|---|---|
committer | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-06-26 19:22:17 (GMT) |
commit | d12e43bc201e15edffcdf94fe820aeae6ab44882 (patch) | |
tree | 90aa12006b20849b65b7bc8e3d4fe60a488f7247 /struct_h5_a_c__cache__image__config__t.html | |
parent | 4d49d1ee001bd4dff6b01e1830902bee22a19f3e (diff) | |
download | hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.zip hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.gz hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.bz2 |
deploy: ab4d2aec9779b7a37747c95bd7b514417b299f73
Diffstat (limited to 'struct_h5_a_c__cache__image__config__t.html')
-rw-r--r-- | struct_h5_a_c__cache__image__config__t.html | 205 |
1 files changed, 205 insertions, 0 deletions
diff --git a/struct_h5_a_c__cache__image__config__t.html b/struct_h5_a_c__cache__image__config__t.html new file mode 100644 index 0000000..5bafad3 --- /dev/null +++ b/struct_h5_a_c__cache__image__config__t.html @@ -0,0 +1,205 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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=9"/> +<meta name="generator" content="Doxygen 1.9.1"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>HDF5: H5AC_cache_image_config_t Struct 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="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.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"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ + $(document).ready(function() { init_search(); }); +/* @license-end */ +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="hdf5doxy.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> +</head> +<body> +<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better serve our user community by answering the following short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a> +  <span id="projectnumber">1.15.0.ab4d2ae</span> + </div> + <div id="projectbrief">API Reference</div> + </td> + <td> <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.svg" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="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()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a> + </span> + </div> +</td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.9.1 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); +/* @license-end */ +</script> +</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"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('struct_h5_a_c__cache__image__config__t.html',''); initResizable(); }); +/* @license-end */ +</script> +<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"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#pub-attribs">Data Fields</a> </div> + <div class="headertitle"> +<div class="title">H5AC_cache_image_config_t Struct Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <src/H5ACpublic.h></code></p> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p><a class="el" href="struct_h5_a_c__cache__image__config__t.html">H5AC_cache_image_config_t</a> is a public structure intended for use in public APIs. At least in its initial incarnation, it is a copy of <code>struct</code> <code>H5C_cache_image_ctl_t</code>. </p> +</div><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> +Data Fields</h2></td></tr> +<tr class="memitem:aad880fc4455c253781e8968f2239d56f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_a_c__cache__image__config__t.html#aad880fc4455c253781e8968f2239d56f">version</a></td></tr> +<tr class="separator:aad880fc4455c253781e8968f2239d56f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad6540e7705dd036e71421880b33ef538"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_a_c__cache__image__config__t.html#ad6540e7705dd036e71421880b33ef538">generate_image</a></td></tr> +<tr class="separator:ad6540e7705dd036e71421880b33ef538"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4e3d7f62b6ed0d946acf335dc314e303"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_a_c__cache__image__config__t.html#a4e3d7f62b6ed0d946acf335dc314e303">save_resize_status</a></td></tr> +<tr class="separator:a4e3d7f62b6ed0d946acf335dc314e303"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aec92d40c46311615f2155573aca27ec4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_a_c__cache__image__config__t.html#aec92d40c46311615f2155573aca27ec4">entry_ageout</a></td></tr> +<tr class="separator:aec92d40c46311615f2155573aca27ec4"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Field Documentation</h2> +<a id="aec92d40c46311615f2155573aca27ec4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aec92d40c46311615f2155573aca27ec4">◆ </a></span>entry_ageout</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int entry_ageout</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Integer field indicating the maximum number of times a prefetched entry can appear in subsequent cache images. This field exists to allow the user to avoid the buildup of infrequently used entries in long sequences of cache images.</p> +<p>The value of this field must lie in the range <a class="el" href="_h5_a_cpublic_8h.html#a4d2023e273e0cdda3c350e4de91baf78">H5AC__CACHE_IMAGE__ENTRY_AGEOUT__NONE</a> (-1) to <a class="el" href="_h5_a_cpublic_8h.html#aa1f7f6392005e5678f609043d644512b">H5AC__CACHE_IMAGE__ENTRY_AGEOUT__MAX</a> (100).</p> +<p><a class="el" href="_h5_a_cpublic_8h.html#a4d2023e273e0cdda3c350e4de91baf78">H5AC__CACHE_IMAGE__ENTRY_AGEOUT__NONE</a> means that no limit is imposed on number of times a prefetched entry can appear in subsequent cache images.</p> +<p>A value of 0 prevents prefetched entries from being included in cache images.</p> +<p>Positive integers restrict prefetched entries to the specified number of appearances.</p> +<p>Note that the number of subsequent cache images that a prefetched entry has appeared in is tracked in an 8 bit field. Thus, while <a class="el" href="_h5_a_cpublic_8h.html#aa1f7f6392005e5678f609043d644512b">H5AC__CACHE_IMAGE__ENTRY_AGEOUT__MAX</a> can be increased from its current value, any value in excess of 255 will be the functional equivalent of <a class="el" href="_h5_a_cpublic_8h.html#a4d2023e273e0cdda3c350e4de91baf78">H5AC__CACHE_IMAGE__ENTRY_AGEOUT__NONE</a>. </p> + +</div> +</div> +<a id="ad6540e7705dd036e71421880b33ef538"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad6540e7705dd036e71421880b33ef538">◆ </a></span>generate_image</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> generate_image</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Boolean flag indicating whether a cache image should be created on file close. </p> + +</div> +</div> +<a id="a4e3d7f62b6ed0d946acf335dc314e303"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4e3d7f62b6ed0d946acf335dc314e303">◆ </a></span>save_resize_status</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> save_resize_status</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Boolean flag indicating whether the cache image should include the adaptive cache resize configuration and status. Note that this field is ignored at present. </p> + +</div> +</div> +<a id="aad880fc4455c253781e8968f2239d56f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aad880fc4455c253781e8968f2239d56f">◆ </a></span>version</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int version</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Integer field containing the version number of this version of the <code>H5C_image_ctl_t</code> structure. Any instance of <code>H5C_image_ctl_t</code> passed to the cache must have a known version number, or an error will be flagged. </p> + +</div> +</div> +<hr/>The documentation for this struct was generated from the following file:<ul> +<li>src/<a class="el" href="_h5_a_cpublic_8h.html">H5ACpublic.h</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="struct_h5_a_c__cache__image__config__t.html">H5AC_cache_image_config_t</a></li> + <li class="footer">Generated on Mon Jun 26 2023 19:01:39 for HDF5 by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.1 </li> + </ul> +</div> +</body> +</html> |