mirror of
https://github.com/HDFGroup/hdf5.git
synced 2026-09-25 04:09:44 +03:00
660 lines
45 KiB
HTML
660 lines
45 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: Event Set Interface (H5ES)</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"> Last Updated on 2026-09-02</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 Page</span></a></li>
|
|
<li><a href="_getting_started.html"><span>Getting started</span></a></li>
|
|
<li><a href="_u_g.html"><span>User Guide</span></a></li>
|
|
<li><a href="_r_m.html"><span>Reference Manual</span></a></li>
|
|
<li><a href="_cookbook.html"><span>Cookbook</span></a></li>
|
|
<li><a href="_t_n.html"><span>Technical 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 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('group___h5_e_s.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">Event Set Interface (H5ES) </div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Event Set Interface. </p>
|
|
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000005">Todo</a></b></dt><dd>Add the event set life cycle.</dd></dl>
|
|
<p><b>This interface can only be used with the HDF5 VOL connectors that enable the asynchronous feature in HDF5.</b> The native HDF5 library has only synchronous operations.</p>
|
|
<p>HDF5 VOL connectors with support for asynchronous operations:</p><ul>
|
|
<li>ASYNC</li>
|
|
<li>DAOS</li>
|
|
</ul>
|
|
<dl class="section user"><dt>Example:</dt><dd><div class="fragment"><div class="line">fid = <a class="code hl_function" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a>(..);</div>
|
|
<div class="line">gid = <a class="code hl_define" href="group___h5_g.html#ga3eca6807deff4f9e51fc5fe0befc2245">H5Gopen</a>(fid, ..); <span class="comment">//Starts when H5Fopen completes</span></div>
|
|
<div class="line">did = <a class="code hl_define" href="_h5version_8h.html#a7dba2e5b2045f31c0932123ffb54f7a3">H5Dopen</a>(gid, ..); <span class="comment">//Starts when H5Gopen completes</span></div>
|
|
<div class="line"> </div>
|
|
<div class="line">es_id = <a class="code hl_function" href="#gae3cd0a94586acf2d824033ef59fd3ccc">H5EScreate</a>(); <span class="comment">// Create event set for tracking async operations</span></div>
|
|
<div class="line">status = <a class="code hl_function" href="group___a_s_y_n_c.html#ga7773f0c3503418421bcb535a95ee832e">H5Dwrite_async</a>(did, .., es_id); <span class="comment">//Asynchronous, starts when H5Dopen completes,</span></div>
|
|
<div class="line"> <span class="comment">// may run concurrently with other H5Dwrite_async</span></div>
|
|
<div class="line"> <span class="comment">// in event set.</span></div>
|
|
<div class="line">status = <a class="code hl_function" href="group___a_s_y_n_c.html#ga7773f0c3503418421bcb535a95ee832e">H5Dwrite_async</a>(did, .., es_id); <span class="comment">//Asynchronous, starts when H5Dopen completes,</span></div>
|
|
<div class="line"> <span class="comment">// may run concurrently with other H5Dwrite_async</span></div>
|
|
<div class="line"> <span class="comment">// in event set....</span></div>
|
|
<div class="line"><other user code></div>
|
|
<div class="line">...</div>
|
|
<div class="line">H5ESwait(es_id); <span class="comment">// Wait for operations in event set to complete, buffers</span></div>
|
|
<div class="line"> <span class="comment">// used for H5Dwrite_async must only be changed after wait</span></div>
|
|
<div class="line"> <span class="comment">// returns.</span></div>
|
|
<div class="ttc" id="a_h5version_8h_html_a7dba2e5b2045f31c0932123ffb54f7a3"><div class="ttname"><a href="_h5version_8h.html#a7dba2e5b2045f31c0932123ffb54f7a3">H5Dopen</a></div><div class="ttdeci">#define H5Dopen</div><div class="ttdef"><b>Definition</b> H5version.h:1219</div></div>
|
|
<div class="ttc" id="agroup___a_s_y_n_c_html_ga7773f0c3503418421bcb535a95ee832e"><div class="ttname"><a href="group___a_s_y_n_c.html#ga7773f0c3503418421bcb535a95ee832e">H5Dwrite_async</a></div><div class="ttdeci">herr_t H5Dwrite_async(hid_t dset_id, hid_t mem_type_id, hid_t mem_space_id, hid_t file_space_id, hid_t dxpl_id, const void *buf, hid_t es_id)</div></div>
|
|
<div class="ttc" id="agroup___h5_e_s_html_gae3cd0a94586acf2d824033ef59fd3ccc"><div class="ttname"><a href="#gae3cd0a94586acf2d824033ef59fd3ccc">H5EScreate</a></div><div class="ttdeci">hid_t H5EScreate(void)</div><div class="ttdoc">Creates an event set.</div></div>
|
|
<div class="ttc" id="agroup___h5_f_html_gaa3f4f877b9bb591f3880423ed2bf44bc"><div class="ttname"><a href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a></div><div class="ttdeci">hid_t H5Fopen(const char *filename, unsigned flags, hid_t fapl_id)</div><div class="ttdoc">Opens an existing HDF5 file.</div></div>
|
|
<div class="ttc" id="agroup___h5_g_html_ga3eca6807deff4f9e51fc5fe0befc2245"><div class="ttname"><a href="group___h5_g.html#ga3eca6807deff4f9e51fc5fe0befc2245">H5Gopen</a></div><div class="ttdeci">#define H5Gopen</div><div class="ttdef"><b>Definition</b> H5version.h:1335</div></div>
|
|
</div><!-- fragment --> </dd></dl>
|
|
</div><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga31adb1cd449abdf71584af89195bf18e" id="r_ga31adb1cd449abdf71584af89195bf18e"><td class="memItemLeft"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight"><a class="el" href="#ga31adb1cd449abdf71584af89195bf18e">H5EScancel</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> es_id, size_t *num_not_canceled, bool *err_occurred)</td></tr>
|
|
<tr class="memdesc:ga31adb1cd449abdf71584af89195bf18e"><td class="mdescLeft"> </td><td class="mdescRight">Attempt to cancel operations in an event set. <br /></td></tr>
|
|
<tr class="memitem:ga1159e2c6748f200857dffa55011ae060" id="r_ga1159e2c6748f200857dffa55011ae060"><td class="memItemLeft"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight"><a class="el" href="#ga1159e2c6748f200857dffa55011ae060">H5ESclose</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> es_id)</td></tr>
|
|
<tr class="memdesc:ga1159e2c6748f200857dffa55011ae060"><td class="mdescLeft"> </td><td class="mdescRight">Terminates access to an event set. <br /></td></tr>
|
|
<tr class="memitem:gae3cd0a94586acf2d824033ef59fd3ccc" id="r_gae3cd0a94586acf2d824033ef59fd3ccc"><td class="memItemLeft"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight"><a class="el" href="#gae3cd0a94586acf2d824033ef59fd3ccc">H5EScreate</a> (void)</td></tr>
|
|
<tr class="memdesc:gae3cd0a94586acf2d824033ef59fd3ccc"><td class="mdescLeft"> </td><td class="mdescRight">Creates an event set. <br /></td></tr>
|
|
<tr class="memitem:gadaab9ec7ce5725bed34636e0cf8cad8d" id="r_gadaab9ec7ce5725bed34636e0cf8cad8d"><td class="memItemLeft"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight"><a class="el" href="#gadaab9ec7ce5725bed34636e0cf8cad8d">H5ESfree_err_info</a> (size_t num_err_info, <a class="el" href="struct_h5_e_s__err__info__t.html">H5ES_err_info_t</a> err_info[])</td></tr>
|
|
<tr class="memdesc:gadaab9ec7ce5725bed34636e0cf8cad8d"><td class="mdescLeft"> </td><td class="mdescRight">Convenience routine to free an array of <a class="el" href="struct_h5_e_s__err__info__t.html">H5ES_err_info_t</a> structs. <br /></td></tr>
|
|
<tr class="memitem:ga1a5a9212958bf7054a56107587d480d2" id="r_ga1a5a9212958bf7054a56107587d480d2"><td class="memItemLeft"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight"><a class="el" href="#ga1a5a9212958bf7054a56107587d480d2">H5ESget_count</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> es_id, size_t *count)</td></tr>
|
|
<tr class="memdesc:ga1a5a9212958bf7054a56107587d480d2"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves number of events in an event set. <br /></td></tr>
|
|
<tr class="memitem:ga42b502d05e0dff40ec550c85bb54ca1c" id="r_ga42b502d05e0dff40ec550c85bb54ca1c"><td class="memItemLeft"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight"><a class="el" href="#ga42b502d05e0dff40ec550c85bb54ca1c">H5ESget_err_count</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> es_id, size_t *num_errs)</td></tr>
|
|
<tr class="memdesc:ga42b502d05e0dff40ec550c85bb54ca1c"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the number of failed operations. <br /></td></tr>
|
|
<tr class="memitem:ga7fe438ffe2d7fcede25e4bec5194c923" id="r_ga7fe438ffe2d7fcede25e4bec5194c923"><td class="memItemLeft"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight"><a class="el" href="#ga7fe438ffe2d7fcede25e4bec5194c923">H5ESget_err_info</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> es_id, size_t num_err_info, <a class="el" href="struct_h5_e_s__err__info__t.html">H5ES_err_info_t</a> err_info[], size_t *err_cleared)</td></tr>
|
|
<tr class="memdesc:ga7fe438ffe2d7fcede25e4bec5194c923"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves information about failed operations. <br /></td></tr>
|
|
<tr class="memitem:ga3f1d63eb93c8466e0132303f506f6d33" id="r_ga3f1d63eb93c8466e0132303f506f6d33"><td class="memItemLeft"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight"><a class="el" href="#ga3f1d63eb93c8466e0132303f506f6d33">H5ESget_err_status</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> es_id, bool *err_occurred)</td></tr>
|
|
<tr class="memdesc:ga3f1d63eb93c8466e0132303f506f6d33"><td class="mdescLeft"> </td><td class="mdescRight">Checks for failed operations. <br /></td></tr>
|
|
<tr class="memitem:ga1880fb2353f677ef56a6204706cec4d0" id="r_ga1880fb2353f677ef56a6204706cec4d0"><td class="memItemLeft"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight"><a class="el" href="#ga1880fb2353f677ef56a6204706cec4d0">H5ESget_op_counter</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> es_id, uint64_t *counter)</td></tr>
|
|
<tr class="memdesc:ga1880fb2353f677ef56a6204706cec4d0"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the accumulative operation counter for an event set. <br /></td></tr>
|
|
<tr class="memitem:gaad19a0bf9ef8816d178f3ee6d1d1ef50" id="r_gaad19a0bf9ef8816d178f3ee6d1d1ef50"><td class="memItemLeft"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight"><a class="el" href="#gaad19a0bf9ef8816d178f3ee6d1d1ef50">H5ESregister_complete_func</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> es_id, <a class="el" href="_h5_e_spublic_8h.html#a203f983be81866b1d8e98c9b4790125c">H5ES_event_complete_func_t</a> func, void *ctx)</td></tr>
|
|
<tr class="memdesc:gaad19a0bf9ef8816d178f3ee6d1d1ef50"><td class="mdescLeft"> </td><td class="mdescRight">Registers a callback to invoke when an operation completes within an event set. <br /></td></tr>
|
|
<tr class="memitem:gac2255859e4038a02e8dea94b2585e9e8" id="r_gac2255859e4038a02e8dea94b2585e9e8"><td class="memItemLeft"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight"><a class="el" href="#gac2255859e4038a02e8dea94b2585e9e8">H5ESregister_insert_func</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> es_id, <a class="el" href="_h5_e_spublic_8h.html#a0657307c8919bf968bd0fc8d7d6afa2d">H5ES_event_insert_func_t</a> func, void *ctx)</td></tr>
|
|
<tr class="memdesc:gac2255859e4038a02e8dea94b2585e9e8"><td class="mdescLeft"> </td><td class="mdescRight">Registers a callback to invoke when a new operation is inserted into an event set. <br /></td></tr>
|
|
<tr class="memitem:ga4f125d5ee5e59e3f6005f07723d306aa" id="r_ga4f125d5ee5e59e3f6005f07723d306aa"><td class="memItemLeft"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight"><a class="el" href="#ga4f125d5ee5e59e3f6005f07723d306aa">H5ESwait</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> es_id, uint64_t timeout, size_t *num_in_progress, bool *err_occurred)</td></tr>
|
|
<tr class="memdesc:ga4f125d5ee5e59e3f6005f07723d306aa"><td class="mdescLeft"> </td><td class="mdescRight">Waits for operations in event set to complete. <br /></td></tr>
|
|
</table>
|
|
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
|
|
<a id="ga31adb1cd449abdf71584af89195bf18e" name="ga31adb1cd449abdf71584af89195bf18e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga31adb1cd449abdf71584af89195bf18e">◆ </a></span>H5EScancel()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5EScancel </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>es_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t *</td> <td class="paramname"><span class="paramname"><em>num_not_canceled</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool *</td> <td class="paramname"><span class="paramname"><em>err_occurred</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Attempt to cancel operations in an event set. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">es_id</td><td>Event set identifier </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">num_not_canceled</td><td>The number of events not canceled </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">err_occurred</td><td>Status indicating if error is present in the event set </td></tr>
|
|
</table>
|
|
</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="#ga31adb1cd449abdf71584af89195bf18e" title="Attempt to cancel operations in an event set.">H5EScancel()</a> attempts to cancel operations in an event set specified by <code class="param">es_id</code>. H5ES_NONE is a valid value for <code class="param">es_id</code>, but functions as a no-op.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.14.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga1159e2c6748f200857dffa55011ae060" name="ga1159e2c6748f200857dffa55011ae060"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga1159e2c6748f200857dffa55011ae060">◆ </a></span>H5ESclose()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5ESclose </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>es_id</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Terminates access to an event set. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">es_id</td><td>Event set identifier </td></tr>
|
|
</table>
|
|
</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="#ga1159e2c6748f200857dffa55011ae060" title="Terminates access to an event set.">H5ESclose()</a> terminates access to an event set specified by <code class="param">es_id</code>.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.14.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gae3cd0a94586acf2d824033ef59fd3ccc" name="gae3cd0a94586acf2d824033ef59fd3ccc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gae3cd0a94586acf2d824033ef59fd3ccc">◆ </a></span>H5EScreate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5EScreate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates an event set. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a event set identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
|
|
<p><a class="el" href="#gae3cd0a94586acf2d824033ef59fd3ccc" title="Creates an event set.">H5EScreate()</a> creates a new event set and returns a corresponding event set identifier.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.14.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gadaab9ec7ce5725bed34636e0cf8cad8d" name="gadaab9ec7ce5725bed34636e0cf8cad8d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gadaab9ec7ce5725bed34636e0cf8cad8d">◆ </a></span>H5ESfree_err_info()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5ESfree_err_info </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>num_err_info</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_h5_e_s__err__info__t.html">H5ES_err_info_t</a></td> <td class="paramname"><span class="paramname"><em>err_info</em></span>[] )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Convenience routine to free an array of <a class="el" href="struct_h5_e_s__err__info__t.html">H5ES_err_info_t</a> structs. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">num_err_info</td><td>The number of elements in <code class="param">err_info</code> array </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">err_info</td><td>Array of structures </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.14.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga1a5a9212958bf7054a56107587d480d2" name="ga1a5a9212958bf7054a56107587d480d2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga1a5a9212958bf7054a56107587d480d2">◆ </a></span>H5ESget_count()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5ESget_count </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>es_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t *</td> <td class="paramname"><span class="paramname"><em>count</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves number of events in an event set. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">es_id</td><td>Event set identifier </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">count</td><td>The number of events in the event set </td></tr>
|
|
</table>
|
|
</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="#ga1a5a9212958bf7054a56107587d480d2" title="Retrieves number of events in an event set.">H5ESget_count()</a> retrieves number of events in an event set specified by <code class="param">es_id</code>.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.14.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga42b502d05e0dff40ec550c85bb54ca1c" name="ga42b502d05e0dff40ec550c85bb54ca1c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga42b502d05e0dff40ec550c85bb54ca1c">◆ </a></span>H5ESget_err_count()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5ESget_err_count </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>es_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t *</td> <td class="paramname"><span class="paramname"><em>num_errs</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves the number of failed operations. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">es_id</td><td>Event set identifier </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">num_errs</td><td>Number of errors </td></tr>
|
|
</table>
|
|
</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="#ga42b502d05e0dff40ec550c85bb54ca1c" title="Retrieves the number of failed operations.">H5ESget_err_count()</a> retrieves the number of failed operations in an event set specified by <code class="param">es_id</code>.</p>
|
|
<p>The function does not wait for active operations to complete, so count may not include all failures.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.14.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga7fe438ffe2d7fcede25e4bec5194c923" name="ga7fe438ffe2d7fcede25e4bec5194c923"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga7fe438ffe2d7fcede25e4bec5194c923">◆ </a></span>H5ESget_err_info()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5ESget_err_info </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>es_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>num_err_info</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_h5_e_s__err__info__t.html">H5ES_err_info_t</a></td> <td class="paramname"><span class="paramname"><em>err_info</em></span>[], </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t *</td> <td class="paramname"><span class="paramname"><em>err_cleared</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves information about failed operations. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">es_id</td><td>Event set identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">num_err_info</td><td>The number of elements in <code class="param">err_info</code> array </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">err_info</td><td>Array of structures </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">err_cleared</td><td>Number of cleared errors </td></tr>
|
|
</table>
|
|
</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="#ga7fe438ffe2d7fcede25e4bec5194c923" title="Retrieves information about failed operations.">H5ESget_err_info()</a> retrieves information about failed operations in an event set specified by <code class="param">es_id</code>. The strings retrieved for each error info must be released by calling <a class="el" href="group___h5.html#ga71872bf6445cba956da86d4762b662cf" title="Frees memory allocated by the HDF5 library.">H5free_memory()</a>.</p>
|
|
<p>Below is the description of the <a class="el" href="struct_h5_e_s__err__info__t.html" title="H5ES_err_info_t">H5ES_err_info_t</a> structure: </p><div class="fragment"><div class="line"></div>
|
|
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_e_s__err__info__t.html">H5ES_err_info_t</a> {</div>
|
|
<div class="line"> <span class="comment">/* API call info */</span></div>
|
|
<div class="line"> <span class="keywordtype">char</span> *<a class="code hl_variable" href="struct_h5_e_s__err__info__t.html#a626231556035d07c144783eb7b69c7e0">api_name</a>; </div>
|
|
<div class="line"> <span class="keywordtype">char</span> *<a class="code hl_variable" href="struct_h5_e_s__err__info__t.html#a2e77d439e7cd1f696a0f3e828a04728f">api_args</a>; </div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">/* Application info */</span></div>
|
|
<div class="line"> <span class="keywordtype">char</span> *<a class="code hl_variable" href="struct_h5_e_s__err__info__t.html#a783ef99ec8a1aedceea00489ebfffeb5">app_file_name</a>; </div>
|
|
<div class="line"> <span class="keywordtype">char</span> *<a class="code hl_variable" href="struct_h5_e_s__err__info__t.html#a13b087b084bb3c56b0d1a5c2e57e09f8">app_func_name</a>; </div>
|
|
<div class="line"> <span class="keywordtype">unsigned</span> <a class="code hl_variable" href="struct_h5_e_s__err__info__t.html#a5ca51c24a0c2c6f3b73c2a3b3a2282e8">app_line_num</a>; </div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">/* Operation info */</span></div>
|
|
<div class="line"> uint64_t <a class="code hl_variable" href="struct_h5_e_s__err__info__t.html#a33675701c7fe6aad490a6b4e1ff99345">op_ins_count</a>; </div>
|
|
<div class="line"> uint64_t <a class="code hl_variable" href="struct_h5_e_s__err__info__t.html#af5de851e0076fcf1b9d1db8f4231c174">op_ins_ts</a>; </div>
|
|
<div class="line"> uint64_t <a class="code hl_variable" href="struct_h5_e_s__err__info__t.html#a84e50df54a166388156fc1d5775c213e">op_exec_ts</a>; </div>
|
|
<div class="line"> uint64_t <a class="code hl_variable" href="struct_h5_e_s__err__info__t.html#a35b3ad1e8c729416bb5506bc6a09069a">op_exec_time</a>; </div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">/* Error info */</span></div>
|
|
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_e_s__err__info__t.html#ac717c89bff4c1eac778f760deec58c31">err_stack_id</a>; </div>
|
|
<div class="line">} <a class="code hl_struct" href="struct_h5_e_s__err__info__t.html">H5ES_err_info_t</a>;</div>
|
|
</div><!-- fragment --><p> (Click on a enumerator, field, or type for more information.)</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.14.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga3f1d63eb93c8466e0132303f506f6d33" name="ga3f1d63eb93c8466e0132303f506f6d33"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga3f1d63eb93c8466e0132303f506f6d33">◆ </a></span>H5ESget_err_status()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5ESget_err_status </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>es_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool *</td> <td class="paramname"><span class="paramname"><em>err_occurred</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks for failed operations. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">es_id</td><td>Event set identifier </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">err_occurred</td><td>Status indicating if error is present in the event set </td></tr>
|
|
</table>
|
|
</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="#ga3f1d63eb93c8466e0132303f506f6d33" title="Checks for failed operations.">H5ESget_err_status()</a> checks if event set specified by es_id has failed operations.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.14.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga1880fb2353f677ef56a6204706cec4d0" name="ga1880fb2353f677ef56a6204706cec4d0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga1880fb2353f677ef56a6204706cec4d0">◆ </a></span>H5ESget_op_counter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5ESget_op_counter </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>es_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint64_t *</td> <td class="paramname"><span class="paramname"><em>counter</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves the accumulative operation counter for an event set. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">es_id</td><td>Event set identifier </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">counter</td><td>The accumulative counter value for an event set </td></tr>
|
|
</table>
|
|
</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="#ga1880fb2353f677ef56a6204706cec4d0" title="Retrieves the accumulative operation counter for an event set.">H5ESget_op_counter()</a> retrieves the current accumulative count of event set operations since the event set creation of <code class="param">es_id</code>.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>This is designed for wrapper libraries mainly, to use as a mechanism for matching operations inserted into the event set with possible errors that occur.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.14.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaad19a0bf9ef8816d178f3ee6d1d1ef50" name="gaad19a0bf9ef8816d178f3ee6d1d1ef50"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaad19a0bf9ef8816d178f3ee6d1d1ef50">◆ </a></span>H5ESregister_complete_func()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5ESregister_complete_func </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>es_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5_e_spublic_8h.html#a203f983be81866b1d8e98c9b4790125c">H5ES_event_complete_func_t</a></td> <td class="paramname"><span class="paramname"><em>func</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>ctx</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Registers a callback to invoke when an operation completes within an event set. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">es_id</td><td>Event set identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>The completion function to register </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>User-specified information (context) to pass to <code class="param">func</code> </td></tr>
|
|
</table>
|
|
</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>Only one complete callback can be registered for each event set. Registering a new callback will replace the existing one. H5ES_NONE is a valid value for 'es_id', but functions as a no-op</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.14.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gac2255859e4038a02e8dea94b2585e9e8" name="gac2255859e4038a02e8dea94b2585e9e8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gac2255859e4038a02e8dea94b2585e9e8">◆ </a></span>H5ESregister_insert_func()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5ESregister_insert_func </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>es_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5_e_spublic_8h.html#a0657307c8919bf968bd0fc8d7d6afa2d">H5ES_event_insert_func_t</a></td> <td class="paramname"><span class="paramname"><em>func</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>ctx</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Registers a callback to invoke when a new operation is inserted into an event set. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">es_id</td><td>Event set identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>The insert function to register </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>User-specified information (context) to pass to <code class="param">func</code> </td></tr>
|
|
</table>
|
|
</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>Only one insert callback can be registered for each event set. Registering a new callback will replace the existing one. H5ES_NONE is a valid value for 'es_id', but functions as a no-op</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.14.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga4f125d5ee5e59e3f6005f07723d306aa" name="ga4f125d5ee5e59e3f6005f07723d306aa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga4f125d5ee5e59e3f6005f07723d306aa">◆ </a></span>H5ESwait()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5ESwait </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>es_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint64_t</td> <td class="paramname"><span class="paramname"><em>timeout</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t *</td> <td class="paramname"><span class="paramname"><em>num_in_progress</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool *</td> <td class="paramname"><span class="paramname"><em>err_occurred</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Waits for operations in event set to complete. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">es_id</td><td>Event set identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>Total time in nanoseconds to wait for all operations in the event set to complete </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">num_in_progress</td><td>The number of operations still in progress </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">err_occurred</td><td>Flag if an operation in the event set failed </td></tr>
|
|
</table>
|
|
</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="#ga4f125d5ee5e59e3f6005f07723d306aa" title="Waits for operations in event set to complete.">H5ESwait()</a> waits for operations in an event set <code class="param">es_id</code> to wait with <code class="param">timeout</code>.</p>
|
|
<p>Timeout value is in nanoseconds, and is for the <a class="el" href="#ga4f125d5ee5e59e3f6005f07723d306aa" title="Waits for operations in event set to complete.">H5ESwait()</a> call and not for each individual operation in the event set. For example, if "10" is passed as a timeout value and the event set waited 4 nanoseconds for the first operation to complete, the remaining operations would be allowed to wait for at most 6 nanoseconds more, i.e., the timeout value used across all operations in the event set until it reaches 0, then any remaining operations are only checked for completion, not waited on.</p>
|
|
<p>This call will stop waiting on operations and will return immediately if an operation fails. If a failure occurs, the value returned for the number of operations in progress may be inaccurate.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.14.0 </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="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>
|