summaryrefslogtreecommitdiffstats
path: root/struct_h5_f_d__ioc__config__t.html
diff options
context:
space:
mode:
authorbyrnHDF <byrnHDF@users.noreply.github.com>2023-06-26 19:22:17 (GMT)
committerbyrnHDF <byrnHDF@users.noreply.github.com>2023-06-26 19:22:17 (GMT)
commitd12e43bc201e15edffcdf94fe820aeae6ab44882 (patch)
tree90aa12006b20849b65b7bc8e3d4fe60a488f7247 /struct_h5_f_d__ioc__config__t.html
parent4d49d1ee001bd4dff6b01e1830902bee22a19f3e (diff)
downloadhdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.zip
hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.gz
hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.bz2
deploy: ab4d2aec9779b7a37747c95bd7b514417b299f73
Diffstat (limited to 'struct_h5_f_d__ioc__config__t.html')
-rw-r--r--struct_h5_f_d__ioc__config__t.html185
1 files changed, 185 insertions, 0 deletions
diff --git a/struct_h5_f_d__ioc__config__t.html b/struct_h5_f_d__ioc__config__t.html
new file mode 100644
index 0000000..b569b2f
--- /dev/null
+++ b/struct_h5_f_d__ioc__config__t.html
@@ -0,0 +1,185 @@
+<!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: H5FD_ioc_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&amp;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>
+ &#160;<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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
+$(document).ready(function(){initNavTree('struct_h5_f_d__ioc__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">H5FD_ioc_config_t Struct Reference</div> </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include &lt;src/H5FDsubfiling/H5FDioc.h&gt;</code></p>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>Configuration structure for <a class="el" href="group___f_a_p_l.html#ga714340ec9cbb65cb0a819e1d775825f0" title="Modifies the specified File Access Property List to use the H5FD_IOC driver.">H5Pset_fapl_ioc()</a> / <a class="el" href="group___f_a_p_l.html#ga8482cdac1272818e4e0f86a665f8ef98" title="Queries a File Access Property List for H5FD_IOC file driver properties.">H5Pget_fapl_ioc()</a> </p>
+<p><a class="el" href="struct_h5_f_d__ioc__config__t.html" title="Configuration structure for H5Pset_fapl_ioc() / H5Pget_fapl_ioc()">H5FD_ioc_config_t</a> is a public structure that is used to pass configuration data to the <a class="el" href="_h5_f_dioc_8h.html#a9d6649a67050fb1101cca3596421b986">H5FD_IOC</a> driver via a File Access Property List. A pointer to an instance of this structure is a parameter to <a class="el" href="group___f_a_p_l.html#ga714340ec9cbb65cb0a819e1d775825f0" title="Modifies the specified File Access Property List to use the H5FD_IOC driver.">H5Pset_fapl_ioc()</a> and <a class="el" href="group___f_a_p_l.html#ga8482cdac1272818e4e0f86a665f8ef98" title="Queries a File Access Property List for H5FD_IOC file driver properties.">H5Pget_fapl_ioc()</a>. </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:a57f54349f4fd1cbbb52058812e146af2"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__ioc__config__t.html#a57f54349f4fd1cbbb52058812e146af2">magic</a></td></tr>
+<tr class="separator:a57f54349f4fd1cbbb52058812e146af2"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:acd99bb05ca015e7d74448acb1deba7ca"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__ioc__config__t.html#acd99bb05ca015e7d74448acb1deba7ca">version</a></td></tr>
+<tr class="separator:acd99bb05ca015e7d74448acb1deba7ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:afa099e28075dad5d1cb509e847bedb9f"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__ioc__config__t.html#afa099e28075dad5d1cb509e847bedb9f">thread_pool_size</a></td></tr>
+<tr class="separator:afa099e28075dad5d1cb509e847bedb9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<h2 class="groupheader">Field Documentation</h2>
+<a id="a57f54349f4fd1cbbb52058812e146af2"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a57f54349f4fd1cbbb52058812e146af2">&#9670;&nbsp;</a></span>magic</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">uint32_t magic</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+<p>A somewhat unique number which distinguishes the <a class="el" href="_h5_f_dioc_8h.html#a9d6649a67050fb1101cca3596421b986">H5FD_IOC</a> driver from other drivers. Used in combination with a version number, it can help to validate a user-generated File Access Property List. This field should be set to <a class="el" href="_h5_f_dioc_8h.html#af37c70faac9bf49fabb12e6b317267a9">H5FD_IOC_FAPL_MAGIC</a>. </p>
+
+</div>
+</div>
+<a id="afa099e28075dad5d1cb509e847bedb9f"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#afa099e28075dad5d1cb509e847bedb9f">&#9670;&nbsp;</a></span>thread_pool_size</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">int32_t thread_pool_size</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+<p>The number of I/O concentrator worker threads to use.</p>
+<p>This value can also be set or adjusted with the <a class="el" href="_h5_f_dioc_8h.html#a4a6f4e95278aebf8a830585a2607648a">H5FD_IOC_THREAD_POOL_SIZE</a> environment variable. </p>
+
+</div>
+</div>
+<a id="acd99bb05ca015e7d74448acb1deba7ca"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#acd99bb05ca015e7d74448acb1deba7ca">&#9670;&nbsp;</a></span>version</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">uint32_t version</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+<p>Version number of the <a class="el" href="struct_h5_f_d__ioc__config__t.html" title="Configuration structure for H5Pset_fapl_ioc() / H5Pget_fapl_ioc()">H5FD_ioc_config_t</a> structure. Any instance passed to <a class="el" href="group___f_a_p_l.html#ga714340ec9cbb65cb0a819e1d775825f0" title="Modifies the specified File Access Property List to use the H5FD_IOC driver.">H5Pset_fapl_ioc()</a> / <a class="el" href="group___f_a_p_l.html#ga8482cdac1272818e4e0f86a665f8ef98" title="Queries a File Access Property List for H5FD_IOC file driver properties.">H5Pget_fapl_ioc()</a> must have a recognized version number or an error will be raised. Currently, this field should be set to <a class="el" href="_h5_f_dioc_8h.html#aa868930a086c6686ada02d9282e7e440">H5FD_IOC_CURR_FAPL_VERSION</a>. </p>
+
+</div>
+</div>
+<hr/>The documentation for this struct was generated from the following file:<ul>
+<li>src/H5FDsubfiling/<a class="el" href="_h5_f_dioc_8h.html">H5FDioc.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_f_d__ioc__config__t.html">H5FD_ioc_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>
generated by cgit v0.12 at 2024-08-22 06:20:21 (GMT)