blob: 980e9afcba68c3e64c4d2c2e6c3fdbd7c916a1e2 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
<!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.10.0"/>
<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>
<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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(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.2908dd1</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </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()"><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.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(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">
<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="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 id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aad880fc4455c253781e8968f2239d56f" id="r_aad880fc4455c253781e8968f2239d56f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#aad880fc4455c253781e8968f2239d56f">version</a></td></tr>
<tr class="separator:aad880fc4455c253781e8968f2239d56f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad6540e7705dd036e71421880b33ef538" id="r_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="#ad6540e7705dd036e71421880b33ef538">generate_image</a></td></tr>
<tr class="separator:ad6540e7705dd036e71421880b33ef538"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e3d7f62b6ed0d946acf335dc314e303" id="r_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="#a4e3d7f62b6ed0d946acf335dc314e303">save_resize_status</a></td></tr>
<tr class="separator:a4e3d7f62b6ed0d946acf335dc314e303"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aec92d40c46311615f2155573aca27ec4" id="r_aec92d40c46311615f2155573aca27ec4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#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" name="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" name="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" name="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" name="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 by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.10.0 </li>
</ul>
</div>
</body>
</html>
|
