diff options
| author | byrnHDF <byrnHDF@users.noreply.github.com> | 2024-01-29 19:10:27 (GMT) |
|---|---|---|
| committer | byrnHDF <byrnHDF@users.noreply.github.com> | 2024-01-29 19:10:27 (GMT) |
| commit | 63b7d411312cb7c38efd1648363e347f27c24048 (patch) | |
| tree | af34e5dc2c0cdb79bc809e2034f7d8c7fed6e2e4 /develop/group___s_w_m_r.html | |
| parent | 6ba66d0a9efca6f012934bfbeb9bf4ef19465bbd (diff) | |
| download | hdf5-63b7d411312cb7c38efd1648363e347f27c24048.zip hdf5-63b7d411312cb7c38efd1648363e347f27c24048.tar.gz hdf5-63b7d411312cb7c38efd1648363e347f27c24048.tar.bz2 | |
deploy: 365e23340cd001ee751da366235ae420156ad728
Diffstat (limited to 'develop/group___s_w_m_r.html')
| -rw-r--r-- | develop/group___s_w_m_r.html | 103 |
1 files changed, 42 insertions, 61 deletions
diff --git a/develop/group___s_w_m_r.html b/develop/group___s_w_m_r.html index f4c5c05..d1f450a 100644 --- a/develop/group___s_w_m_r.html +++ b/develop/group___s_w_m_r.html @@ -3,7 +3,7 @@ <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="generator" content="Doxygen 1.10.0"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>HDF5: Single Writer Multiple Readers</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> @@ -13,12 +13,13 @@ <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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ - $(document).ready(function() { init_search(); }); +/* @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" /> @@ -37,17 +38,14 @@ <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.5f5f5f0</span> +  <span id="projectnumber">1.15.0.365e233</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" + <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)"/> @@ -61,10 +59,10 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.9.1 --> +<!-- Generated by Doxygen 1.10.0 --> <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 magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +var searchBox = new SearchBox("searchBox", "search/",'.html'); /* @license-end */ </script> </div><!-- top --> @@ -79,8 +77,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); </div> </div> <script type="text/javascript"> -/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ -$(document).ready(function(){initNavTree('group___s_w_m_r.html',''); initResizable(); }); +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +$(function(){initNavTree('group___s_w_m_r.html',''); initResizable(); }); /* @license-end */ </script> <div id="doc-content"> @@ -93,43 +91,38 @@ $(document).ready(function(){initNavTree('group___s_w_m_r.html',''); initResizab <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> -<iframe src="javascript:void(0)" frameborder="0" - name="MSearchResults" id="MSearchResults"> -</iframe> +<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="#func-members">Functions</a> </div> - <div class="headertitle"> -<div class="title">Single Writer Multiple Readers<div class="ingroups"><a class="el" href="group___h5_f.html">Files (H5F)</a></div></div> </div> + <div class="headertitle"><div class="title">Single Writer Multiple Readers<div class="ingroups"><a class="el" href="group___h5_f.html">Files (H5F)</a></div></div></div> </div><!--header--> <div class="contents"> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> - <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Collaboration diagram for Single Writer Multiple Readers:</div> -<div id="dynsection-0-summary" class="dynsummary" style="display:block;"> -</div> -<div id="dynsection-0-content" class="dyncontent" style="display:none;"> -<div class="center"><img src="group___s_w_m_r.png" border="0" usemap="#agroup______s__w__m__r" alt=""/></div> -<map name="agroup______s__w__m__r" id="agroup______s__w__m__r"> -<area shape="rect" href="group___h5_f.html" title=" " alt="" coords="5,13,97,38"/> -<area shape="rect" title=" " alt="" coords="145,5,308,45"/> -</map> -</div> <table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a> Functions</h2></td></tr> -<tr class="memitem:gaa80bd62f19993e414e383db7d1623e5f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_w_m_r.html#gaa80bd62f19993e414e383db7d1623e5f">H5Fget_metadata_read_retry_info</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id, <a class="el" href="struct_h5_f__retry__info__t.html">H5F_retry_info_t</a> *info)</td></tr> -<tr class="memdesc:gaa80bd62f19993e414e383db7d1623e5f"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the collection of read retries for metadata entries with checksum. <a href="group___s_w_m_r.html#gaa80bd62f19993e414e383db7d1623e5f">More...</a><br /></td></tr> +<tr class="memitem:gaa80bd62f19993e414e383db7d1623e5f" id="r_gaa80bd62f19993e414e383db7d1623e5f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa80bd62f19993e414e383db7d1623e5f">H5Fget_metadata_read_retry_info</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id, <a class="el" href="struct_h5_f__retry__info__t.html">H5F_retry_info_t</a> *info)</td></tr> +<tr class="memdesc:gaa80bd62f19993e414e383db7d1623e5f"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the collection of read retries for metadata entries with checksum. <br /></td></tr> <tr class="separator:gaa80bd62f19993e414e383db7d1623e5f"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga159be34fbe7e4a959589310ef0196dfe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_w_m_r.html#ga159be34fbe7e4a959589310ef0196dfe">H5Fstart_swmr_write</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id)</td></tr> -<tr class="memdesc:ga159be34fbe7e4a959589310ef0196dfe"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves free-space section information for a file. <a href="group___s_w_m_r.html#ga159be34fbe7e4a959589310ef0196dfe">More...</a><br /></td></tr> +<tr class="memitem:ga159be34fbe7e4a959589310ef0196dfe" id="r_ga159be34fbe7e4a959589310ef0196dfe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga159be34fbe7e4a959589310ef0196dfe">H5Fstart_swmr_write</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id)</td></tr> +<tr class="memdesc:ga159be34fbe7e4a959589310ef0196dfe"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves free-space section information for a file. <br /></td></tr> <tr class="separator:ga159be34fbe7e4a959589310ef0196dfe"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Function Documentation</h2> -<a id="gaa80bd62f19993e414e383db7d1623e5f"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gaa80bd62f19993e414e383db7d1623e5f">◆ </a></span>H5Fget_metadata_read_retry_info()</h2> +<a id="gaa80bd62f19993e414e383db7d1623e5f" name="gaa80bd62f19993e414e383db7d1623e5f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaa80bd62f19993e414e383db7d1623e5f">◆ </a></span>H5Fget_metadata_read_retry_info()</h2> <div class="memitem"> <div class="memproto"> @@ -137,19 +130,12 @@ Functions</h2></td></tr> <tr> <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Fget_metadata_read_retry_info </td> <td>(</td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>file_id</em>, </td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>file_id</em>, </span></td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype"><a class="el" href="struct_h5_f__retry__info__t.html">H5F_retry_info_t</a> * </td> - <td class="paramname"><em>info</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> + <td class="paramtype"><a class="el" href="struct_h5_f__retry__info__t.html">H5F_retry_info_t</a> *</td> <td class="paramname"><span class="paramname"><em>info</em></span> )</td> </tr> </table> </div><div class="memdoc"> @@ -169,16 +155,12 @@ Functions</h2></td></tr> <li>When the pointer to the output structure is NULL. </li> <li>When the memory allocation for <code>retries</code> failed.</li> </ul> -<p><a class="el" href="group___s_w_m_r.html#gaa80bd62f19993e414e383db7d1623e5f" title="Retrieves the collection of read retries for metadata entries with checksum.">H5Fget_metadata_read_retry_info()</a> retrieves information regarding the number of read retries for metadata entries with checksum for the file <code>file_id</code>. This information is reported in the <a class="el" href="struct_h5_f__retry__info__t.html">H5F_retry_info_t</a> struct defined in <a class="el" href="_h5_fpublic_8h.html">H5Fpublic.h</a> as follows: </p><div class="fragment"><div class="line"><span class="preprocessor">#define H5F_NUM_METADATA_READ_RETRY_TYPES 21</span></div> +<p><a class="el" href="#gaa80bd62f19993e414e383db7d1623e5f" title="Retrieves the collection of read retries for metadata entries with checksum.">H5Fget_metadata_read_retry_info()</a> retrieves information regarding the number of read retries for metadata entries with checksum for the file <code>file_id</code>. This information is reported in the <a class="el" href="struct_h5_f__retry__info__t.html">H5F_retry_info_t</a> struct defined in <a class="el" href="_h5_fpublic_8h.html">H5Fpublic.h</a> as follows: </p><div class="fragment"><div class="line"><span class="preprocessor">#define H5F_NUM_METADATA_READ_RETRY_TYPES 21</span></div> <div class="line"> </div> -<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_h5_f__retry__info__t.html">H5F_retry_info_t</a> {</div> -<div class="line"> <span class="keywordtype">unsigned</span> <a class="code" href="struct_h5_f__retry__info__t.html#aa86f48adcf8ee5bbe9d05ae595130544">nbins</a>;</div> -<div class="line"> uint32_t *<a class="code" href="struct_h5_f__retry__info__t.html#a9ed64b2becff4cade9713b0cd9f3827e">retries</a>[<a class="code" href="_h5_fpublic_8h.html#a3a67d0d121762e7c44c4ef3f40a49611">H5F_NUM_METADATA_READ_RETRY_TYPES</a>];</div> -<div class="line">} <a class="code" href="struct_h5_f__retry__info__t.html">H5F_retry_info_t</a>;</div> -<div class="ttc" id="a_h5_fpublic_8h_html_a3a67d0d121762e7c44c4ef3f40a49611"><div class="ttname"><a href="_h5_fpublic_8h.html#a3a67d0d121762e7c44c4ef3f40a49611">H5F_NUM_METADATA_READ_RETRY_TYPES</a></div><div class="ttdeci">#define H5F_NUM_METADATA_READ_RETRY_TYPES</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:228</div></div> -<div class="ttc" id="astruct_h5_f__retry__info__t_html"><div class="ttname"><a href="struct_h5_f__retry__info__t.html">H5F_retry_info_t</a></div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:234</div></div> -<div class="ttc" id="astruct_h5_f__retry__info__t_html_a9ed64b2becff4cade9713b0cd9f3827e"><div class="ttname"><a href="struct_h5_f__retry__info__t.html#a9ed64b2becff4cade9713b0cd9f3827e">H5F_retry_info_t::retries</a></div><div class="ttdeci">uint32_t * retries[21]</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:236</div></div> -<div class="ttc" id="astruct_h5_f__retry__info__t_html_aa86f48adcf8ee5bbe9d05ae595130544"><div class="ttname"><a href="struct_h5_f__retry__info__t.html#aa86f48adcf8ee5bbe9d05ae595130544">H5F_retry_info_t::nbins</a></div><div class="ttdeci">unsigned nbins</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:235</div></div> +<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_f__retry__info__t.html">H5F_retry_info_t</a> {</div> +<div class="line"> <span class="keywordtype">unsigned</span> <a class="code hl_variable" href="struct_h5_f__retry__info__t.html#aa86f48adcf8ee5bbe9d05ae595130544">nbins</a>;</div> +<div class="line"> uint32_t *<a class="code hl_variable" href="struct_h5_f__retry__info__t.html#a9ed64b2becff4cade9713b0cd9f3827e">retries</a>[<a class="code hl_define" href="_h5_fpublic_8h.html#a3a67d0d121762e7c44c4ef3f40a49611">H5F_NUM_METADATA_READ_RETRY_TYPES</a>];</div> +<div class="line">} <a class="code hl_struct" href="struct_h5_f__retry__info__t.html">H5F_retry_info_t</a>;</div> </div><!-- fragment --><p> <code>nbins</code> is the number of bins for each <code>retries</code>[i] of metadata entry <code>i</code>. It is calculated based on the current number of read attempts used in the library and logarithmic base 10.</p> <p>If read retries are incurred for a metadata entry <code>i</code>, the library will allocate memory for <code>retries[i] (nbins * sizeof(uint32_t)</code> and store the collection of retries there. If there are no retries for a metadata entry <code>i</code>, <code>retries[i]</code> will be NULL. After a call to this routine, users should free each <code>retries[i]</code> that is non-NULL, otherwise resource leak will occur.</p> <p>For the library default read attempts of 100 for SWMR access, nbins will be 2 as depicted below: </p><ul> @@ -239,8 +221,8 @@ Functions</h2></td></tr> </div> </div> -<a id="ga159be34fbe7e4a959589310ef0196dfe"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga159be34fbe7e4a959589310ef0196dfe">◆ </a></span>H5Fstart_swmr_write()</h2> +<a id="ga159be34fbe7e4a959589310ef0196dfe" name="ga159be34fbe7e4a959589310ef0196dfe"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga159be34fbe7e4a959589310ef0196dfe">◆ </a></span>H5Fstart_swmr_write()</h2> <div class="memitem"> <div class="memproto"> @@ -248,8 +230,7 @@ Functions</h2></td></tr> <tr> <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Fstart_swmr_write </td> <td>(</td> - <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> - <td class="paramname"><em>file_id</em></td><td>)</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>file_id</em></span></td><td>)</td> <td></td> </tr> </table> @@ -263,7 +244,7 @@ Functions</h2></td></tr> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> -<p><a class="el" href="group___s_w_m_r.html#ga159be34fbe7e4a959589310ef0196dfe" title="Retrieves free-space section information for a file.">H5Fstart_swmr_write()</a> will activate SWMR writing mode for a file associated with <code>file_id</code>. This routine will prepare and ensure the file is safe for SWMR writing as follows: </p><ul> +<p><a class="el" href="#ga159be34fbe7e4a959589310ef0196dfe" title="Retrieves free-space section information for a file.">H5Fstart_swmr_write()</a> will activate SWMR writing mode for a file associated with <code>file_id</code>. This routine will prepare and ensure the file is safe for SWMR writing as follows: </p><ul> <li>Check that the file is opened with write access (<a class="el" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a>). </li> <li>Check that the file is opened with the latest library format to ensure data structures with check-summed metadata are used. </li> <li>Check that the file is not already marked in SWMR writing mode. </li> @@ -283,7 +264,7 @@ Functions</h2></td></tr> <ul> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> - <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.1 </li> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.10.0 </li> </ul> </div> </body> |