summaryrefslogtreecommitdiffstats
path: root/develop/struct_h5_f_d__mirror__fapl__t.html
diff options
context:
space:
mode:
authorlrknox <lrknox@users.noreply.github.com>2024-03-17 00:55:19 (GMT)
committerlrknox <lrknox@users.noreply.github.com>2024-03-17 00:55:19 (GMT)
commit80463afba2fe736e4c3d9f0548785c6a29f85504 (patch)
tree4716e85ce33bc2566dd14b51e5ed7b478fd5586b /develop/struct_h5_f_d__mirror__fapl__t.html
parent68654009b514666e0b92657686c1b919e76df810 (diff)
downloadhdf5-80463afba2fe736e4c3d9f0548785c6a29f85504.zip
hdf5-80463afba2fe736e4c3d9f0548785c6a29f85504.tar.gz
hdf5-80463afba2fe736e4c3d9f0548785c6a29f85504.tar.bz2
deploy: 68e8c0e62724b2a450e30f2becdcc9452ac0abb4
Diffstat (limited to 'develop/struct_h5_f_d__mirror__fapl__t.html')
-rw-r--r--develop/struct_h5_f_d__mirror__fapl__t.html21
1 files changed, 14 insertions, 7 deletions
diff --git a/develop/struct_h5_f_d__mirror__fapl__t.html b/develop/struct_h5_f_d__mirror__fapl__t.html
index 3238916..73ed8c5 100644
--- a/develop/struct_h5_f_d__mirror__fapl__t.html
+++ b/develop/struct_h5_f_d__mirror__fapl__t.html
@@ -38,7 +38,7 @@
<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.6d85ea2</span>
+ &#160;<span id="projectnumber">1.15.0.68e8c0e</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
@@ -111,7 +111,10 @@ $(function(){initNavTree('struct_h5_f_d__mirror__fapl__t.html',''); initResizabl
<div class="contents">
<p><code>#include &lt;src/H5FDmirror.h&gt;</code></p>
-<table class="memberdecls">
+<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#ga8491676811ccc7ba582e30fb63da6563" title="Modifies the file access property list to use the H5FD_MIRROR driver.">H5Pset_fapl_mirror()</a> / <a class="el" href="group___f_a_p_l.html#ga2c0636d9bb9c50d381afbd0d3140e593" title="Queries a File Access Property List for H5FD_MIRROR file driver properties.">H5Pget_fapl_mirror()</a> </p>
+<p><a class="el" href="struct_h5_f_d__mirror__fapl__t.html" title="Configuration structure for H5Pset_fapl_mirror() / H5Pget_fapl_mirror()">H5FD_mirror_fapl_t</a> is a public structure that is used to pass configuration data to the <a class="el" href="_h5_f_dmirror_8h.html#a05b78c6f3d122b4112632080474b3412">H5FD_MIRROR</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#ga8491676811ccc7ba582e30fb63da6563" title="Modifies the file access property list to use the H5FD_MIRROR driver.">H5Pset_fapl_mirror()</a> and <a class="el" href="group___f_a_p_l.html#ga2c0636d9bb9c50d381afbd0d3140e593" title="Queries a File Access Property List for H5FD_MIRROR file driver properties.">H5Pget_fapl_mirror()</a>. </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:a57f54349f4fd1cbbb52058812e146af2" id="r_a57f54349f4fd1cbbb52058812e146af2"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a57f54349f4fd1cbbb52058812e146af2">magic</a></td></tr>
@@ -120,8 +123,8 @@ Data Fields</h2></td></tr>
<tr class="separator:acd99bb05ca015e7d74448acb1deba7ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4134753d5788dc641ce8a3e3a924881c" id="r_a4134753d5788dc641ce8a3e3a924881c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4134753d5788dc641ce8a3e3a924881c">handshake_port</a></td></tr>
<tr class="separator:a4134753d5788dc641ce8a3e3a924881c"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:acdb1ebff2a0d80f9b0c20a490c18a3b1" id="r_acdb1ebff2a0d80f9b0c20a490c18a3b1"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acdb1ebff2a0d80f9b0c20a490c18a3b1">remote_ip</a> [32+1]</td></tr>
-<tr class="separator:acdb1ebff2a0d80f9b0c20a490c18a3b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:adbfc20d8ab3b559e467aa09a31f49d58" id="r_adbfc20d8ab3b559e467aa09a31f49d58"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adbfc20d8ab3b559e467aa09a31f49d58">remote_ip</a> [32+1]</td></tr>
+<tr class="separator:adbfc20d8ab3b559e467aa09a31f49d58"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a id="a4134753d5788dc641ce8a3e3a924881c" name="a4134753d5788dc641ce8a3e3a924881c"></a>
@@ -135,6 +138,7 @@ Data Fields</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
+<p>Port number on the remote host. </p>
</div>
</div>
@@ -149,20 +153,22 @@ Data Fields</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
+<p>Semi-unique number to sanity-check pointers to this structure type. Must equal H5FD_MIRROR_FAPL_MAGIC to be considered valid. </p>
</div>
</div>
-<a id="acdb1ebff2a0d80f9b0c20a490c18a3b1" name="acdb1ebff2a0d80f9b0c20a490c18a3b1"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#acdb1ebff2a0d80f9b0c20a490c18a3b1">&#9670;&#160;</a></span>remote_ip</h2>
+<a id="adbfc20d8ab3b559e467aa09a31f49d58" name="adbfc20d8ab3b559e467aa09a31f49d58"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#adbfc20d8ab3b559e467aa09a31f49d58">&#9670;&#160;</a></span>remote_ip</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">char remote_ip[32+1]</td>
+ <td class="memname">char remote_ip[<a class="el" href="_h5_f_dmirror_8h.html#a177e28c121e8c29397ee7fe66e62ab56">H5FD_MIRROR_MAX_IP_LEN</a>+1]</td>
</tr>
</table>
</div><div class="memdoc">
+<p>IP address string of the remote host. </p>
</div>
</div>
@@ -177,6 +183,7 @@ Data Fields</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
+<p>Version number of the <a class="el" href="struct_h5_f_d__mirror__fapl__t.html" title="Configuration structure for H5Pset_fapl_mirror() / H5Pget_fapl_mirror()">H5FD_mirror_fapl_t</a> structure. Any instance passed to <a class="el" href="group___f_a_p_l.html#ga8491676811ccc7ba582e30fb63da6563" title="Modifies the file access property list to use the H5FD_MIRROR driver.">H5Pset_fapl_mirror()</a> / <a class="el" href="group___f_a_p_l.html#ga2c0636d9bb9c50d381afbd0d3140e593" title="Queries a File Access Property List for H5FD_MIRROR file driver properties.">H5Pget_fapl_mirror()</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_dmirror_8h.html#ab7fd09353683690e7104e6b38a612f8a">H5FD_MIRROR_CURR_FAPL_T_VERSION</a>. </p>
</div>
</div>