blob: 98c77a33c4d262a914516f0107291f297d276835 (
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
|
<!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: src/H5FDros3.h File 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.7aed6ab</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('_h5_f_dros3_8h.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="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">H5FDros3.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__ros3__fapl__t.html">H5FD_ros3_fapl_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Configuration structure for <a class="el" href="group___f_a_p_l.html#gaad28d8c24f236590193215c5ae7a8f18" title="Modifies the specified File Access Property List to use the H5FD_ROS3 driver.">H5Pset_fapl_ros3()</a> / <a class="el" href="group___f_a_p_l.html#ga13e273711e160cbd58e60c701b4f50e6" title="Queries a File Access Property List for H5FD_ROS3 file driver properties.">H5Pget_fapl_ros3()</a>. <a href="struct_h5_f_d__ros3__fapl__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ace004a4771dcfd40a4c0adecc1974570" id="r_ace004a4771dcfd40a4c0adecc1974570"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ace004a4771dcfd40a4c0adecc1974570">H5FD_ROS3</a>   (<a class="el" href="_h5_f_ddevelop_8h.html#a4df4d59c642c469f7a2c8934bfc84d60">H5FDperform_init</a>(H5FD_ros3_init))</td></tr>
<tr class="separator:ace004a4771dcfd40a4c0adecc1974570"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aea0d0c807838178043b65ef66a6352c5" id="r_aea0d0c807838178043b65ef66a6352c5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#aea0d0c807838178043b65ef66a6352c5">H5FD_ROS3_VALUE</a>   <a class="el" href="_h5_f_dpublic_8h.html#a498d8f0d3383daf1cc08312aece03c9f">H5_VFD_ROS3</a></td></tr>
<tr class="separator:aea0d0c807838178043b65ef66a6352c5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0370e0bade82fd8ff6ac012644599fe2" id="r_a0370e0bade82fd8ff6ac012644599fe2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0370e0bade82fd8ff6ac012644599fe2">H5FD_CURR_ROS3_FAPL_T_VERSION</a>   1</td></tr>
<tr class="separator:a0370e0bade82fd8ff6ac012644599fe2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeaebf5218d3c900eb9a8d981f18a5bd6" id="r_aeaebf5218d3c900eb9a8d981f18a5bd6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#aeaebf5218d3c900eb9a8d981f18a5bd6">H5FD_ROS3_MAX_REGION_LEN</a>   32</td></tr>
<tr class="separator:aeaebf5218d3c900eb9a8d981f18a5bd6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0dfcbaac69a09596185e619bc9f1c460" id="r_a0dfcbaac69a09596185e619bc9f1c460"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0dfcbaac69a09596185e619bc9f1c460">H5FD_ROS3_MAX_SECRET_ID_LEN</a>   128</td></tr>
<tr class="separator:a0dfcbaac69a09596185e619bc9f1c460"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6492f232f64a036290090e7cdf2f9161" id="r_a6492f232f64a036290090e7cdf2f9161"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6492f232f64a036290090e7cdf2f9161">H5FD_ROS3_MAX_SECRET_KEY_LEN</a>   128</td></tr>
<tr class="separator:a6492f232f64a036290090e7cdf2f9161"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a70d7acc7037e8b4322c1fdb4dafc45ba" id="r_a70d7acc7037e8b4322c1fdb4dafc45ba"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a70d7acc7037e8b4322c1fdb4dafc45ba">H5FD_ROS3_MAX_SECRET_TOK_LEN</a>   1024</td></tr>
<tr class="separator:a70d7acc7037e8b4322c1fdb4dafc45ba"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga13e273711e160cbd58e60c701b4f50e6" id="r_ga13e273711e160cbd58e60c701b4f50e6"><td class="memItemLeft" align="right" valign="top">H5_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_a_p_l.html#ga13e273711e160cbd58e60c701b4f50e6">H5Pget_fapl_ros3</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id, <a class="el" href="struct_h5_f_d__ros3__fapl__t.html">H5FD_ros3_fapl_t</a> *fa_out)</td></tr>
<tr class="memdesc:ga13e273711e160cbd58e60c701b4f50e6"><td class="mdescLeft"> </td><td class="mdescRight">Queries a File Access Property List for <a class="el" href="#ace004a4771dcfd40a4c0adecc1974570">H5FD_ROS3</a> file driver properties. <br /></td></tr>
<tr class="separator:ga13e273711e160cbd58e60c701b4f50e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaad28d8c24f236590193215c5ae7a8f18" id="r_gaad28d8c24f236590193215c5ae7a8f18"><td class="memItemLeft" align="right" valign="top">H5_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_a_p_l.html#gaad28d8c24f236590193215c5ae7a8f18">H5Pset_fapl_ros3</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id, const <a class="el" href="struct_h5_f_d__ros3__fapl__t.html">H5FD_ros3_fapl_t</a> *fa)</td></tr>
<tr class="memdesc:gaad28d8c24f236590193215c5ae7a8f18"><td class="mdescLeft"> </td><td class="mdescRight">Modifies the specified File Access Property List to use the <a class="el" href="#ace004a4771dcfd40a4c0adecc1974570">H5FD_ROS3</a> driver. <br /></td></tr>
<tr class="separator:gaad28d8c24f236590193215c5ae7a8f18"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafa91f06270a937cbbf20457ce0a7027e" id="r_gafa91f06270a937cbbf20457ce0a7027e"><td class="memItemLeft" align="right" valign="top">H5_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_a_p_l.html#gafa91f06270a937cbbf20457ce0a7027e">H5Pget_fapl_ros3_token</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id, size_t size, char *token)</td></tr>
<tr class="memdesc:gafa91f06270a937cbbf20457ce0a7027e"><td class="mdescLeft"> </td><td class="mdescRight">Queries a File Access Property List for <a class="el" href="#ace004a4771dcfd40a4c0adecc1974570">H5FD_ROS3</a> file driver session/security token. <br /></td></tr>
<tr class="separator:gafa91f06270a937cbbf20457ce0a7027e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga42bc76c556951027e30c4d26394323c6" id="r_ga42bc76c556951027e30c4d26394323c6"><td class="memItemLeft" align="right" valign="top">H5_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_a_p_l.html#ga42bc76c556951027e30c4d26394323c6">H5Pset_fapl_ros3_token</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id, const char *token)</td></tr>
<tr class="memdesc:ga42bc76c556951027e30c4d26394323c6"><td class="mdescLeft"> </td><td class="mdescRight">Modifies the specified File Access Property List to use the <a class="el" href="#ace004a4771dcfd40a4c0adecc1974570">H5FD_ROS3</a> driver by adding the specified session/security token. <br /></td></tr>
<tr class="separator:ga42bc76c556951027e30c4d26394323c6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a0370e0bade82fd8ff6ac012644599fe2" name="a0370e0bade82fd8ff6ac012644599fe2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0370e0bade82fd8ff6ac012644599fe2">◆ </a></span>H5FD_CURR_ROS3_FAPL_T_VERSION</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5FD_CURR_ROS3_FAPL_T_VERSION   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>The version number of the <a class="el" href="struct_h5_f_d__ros3__fapl__t.html" title="Configuration structure for H5Pset_fapl_ros3() / H5Pget_fapl_ros3().">H5FD_ros3_fapl_t</a> configuration structure for the $H5FD_ROS3 driver. </p>
</div>
</div>
<a id="ace004a4771dcfd40a4c0adecc1974570" name="ace004a4771dcfd40a4c0adecc1974570"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace004a4771dcfd40a4c0adecc1974570">◆ </a></span>H5FD_ROS3</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5FD_ROS3   (<a class="el" href="_h5_f_ddevelop_8h.html#a4df4d59c642c469f7a2c8934bfc84d60">H5FDperform_init</a>(H5FD_ros3_init))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializer for the ros3 VFD </p>
</div>
</div>
<a id="aeaebf5218d3c900eb9a8d981f18a5bd6" name="aeaebf5218d3c900eb9a8d981f18a5bd6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeaebf5218d3c900eb9a8d981f18a5bd6">◆ </a></span>H5FD_ROS3_MAX_REGION_LEN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5FD_ROS3_MAX_REGION_LEN   32</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum string length for specifying the region of the S3 bucket. </p>
</div>
</div>
<a id="a0dfcbaac69a09596185e619bc9f1c460" name="a0dfcbaac69a09596185e619bc9f1c460"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0dfcbaac69a09596185e619bc9f1c460">◆ </a></span>H5FD_ROS3_MAX_SECRET_ID_LEN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5FD_ROS3_MAX_SECRET_ID_LEN   128</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum string length for specifying the security ID. </p>
</div>
</div>
<a id="a6492f232f64a036290090e7cdf2f9161" name="a6492f232f64a036290090e7cdf2f9161"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6492f232f64a036290090e7cdf2f9161">◆ </a></span>H5FD_ROS3_MAX_SECRET_KEY_LEN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5FD_ROS3_MAX_SECRET_KEY_LEN   128</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum string length for specifying the security key. </p>
</div>
</div>
<a id="a70d7acc7037e8b4322c1fdb4dafc45ba" name="a70d7acc7037e8b4322c1fdb4dafc45ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70d7acc7037e8b4322c1fdb4dafc45ba">◆ </a></span>H5FD_ROS3_MAX_SECRET_TOK_LEN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5FD_ROS3_MAX_SECRET_TOK_LEN   1024</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum string length for specifying the session/security token. </p>
</div>
</div>
<a id="aea0d0c807838178043b65ef66a6352c5" name="aea0d0c807838178043b65ef66a6352c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea0d0c807838178043b65ef66a6352c5">◆ </a></span>H5FD_ROS3_VALUE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5FD_ROS3_VALUE   <a class="el" href="_h5_f_dpublic_8h.html#a498d8f0d3383daf1cc08312aece03c9f">H5_VFD_ROS3</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Identifier for the ros3 VFD </p>
</div>
</div>
</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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="_h5_f_dros3_8h.html">H5FDros3.h</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>
|