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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
|
<!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.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>LLFIO: llfio_v2_xxx::fs_handle Class 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">
$(document).ready(initResizable);
</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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">LLFIO
 <span id="projectnumber">v2.00 late alpha</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</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">
$(document).ready(function(){initNavTree('classllfio__v2__xxx_1_1fs__handle.html','');});
</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-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classllfio__v2__xxx_1_1fs__handle-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">llfio_v2_xxx::fs_handle Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>A handle to something with a device and inode number.
<a href="classllfio__v2__xxx_1_1fs__handle.html#details">More...</a></p>
<p><code>#include "fs_handle.hpp"</code></p>
<div class="dynheader">
Inheritance diagram for llfio_v2_xxx::fs_handle:</div>
<div class="dyncontent">
<div class="center">
<img src="classllfio__v2__xxx_1_1fs__handle.png" usemap="#llfio_5Fv2_5Fxxx::fs_5Fhandle_map" alt=""/>
<map id="llfio_5Fv2_5Fxxx::fs_5Fhandle_map" name="llfio_5Fv2_5Fxxx::fs_5Fhandle_map">
<area href="classllfio__v2__xxx_1_1directory__handle.html" title="A handle to a directory which can be enumerated. " alt="llfio_v2_xxx::directory_handle" shape="rect" coords="0,56,222,80"/>
<area href="classllfio__v2__xxx_1_1file__handle.html" title="A handle to a regular file or device, kept data layout compatible with async_file_handle. " alt="llfio_v2_xxx::file_handle" shape="rect" coords="232,56,454,80"/>
<area href="classllfio__v2__xxx_1_1symlink__handle.html" title="A handle to an inode which redirects to a different path. " alt="llfio_v2_xxx::symlink_handle" shape="rect" coords="464,56,686,80"/>
<area href="classllfio__v2__xxx_1_1async__file__handle.html" title="An asynchronous handle to an open something. " alt="llfio_v2_xxx::async_file_handle" shape="rect" coords="0,112,222,136"/>
<area href="classllfio__v2__xxx_1_1fast__random__file__handle.html" title="A handle to synthesised, non-cryptographic, pseudo-random data. " alt="llfio_v2_xxx::fast_random_file_handle" shape="rect" coords="232,112,454,136"/>
<area href="classllfio__v2__xxx_1_1mapped__file__handle.html" title="A memory mapped regular file or device. " alt="llfio_v2_xxx::mapped_file_handle" shape="rect" coords="464,112,686,136"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ac43e0058de471b7b8c4a9f08e621038f"><td class="memItemLeft" align="right" valign="top"><a id="ac43e0058de471b7b8c4a9f08e621038f"></a>
using </td><td class="memItemRight" valign="bottom"><b>dev_t</b> = uint64_t</td></tr>
<tr class="separator:ac43e0058de471b7b8c4a9f08e621038f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6716da1bdd65c32c91eb3e4f34ccde98"><td class="memItemLeft" align="right" valign="top"><a id="a6716da1bdd65c32c91eb3e4f34ccde98"></a>
using </td><td class="memItemRight" valign="bottom"><b>ino_t</b> = uint64_t</td></tr>
<tr class="separator:a6716da1bdd65c32c91eb3e4f34ccde98"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abcd8c8171f4e561620864295e8d5879b"><td class="memItemLeft" align="right" valign="top"><a id="abcd8c8171f4e561620864295e8d5879b"></a>
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1fs__handle.html#abcd8c8171f4e561620864295e8d5879b">path_view_type</a> = <a class="el" href="classllfio__v2__xxx_1_1path__view.html">path_view</a></td></tr>
<tr class="memdesc:abcd8c8171f4e561620864295e8d5879b"><td class="mdescLeft"> </td><td class="mdescRight">The path view type used by this handle. <br /></td></tr>
<tr class="separator:abcd8c8171f4e561620864295e8d5879b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a65884346740af7fb4648c79d44a750"><td class="memItemLeft" align="right" valign="top"><a id="a1a65884346740af7fb4648c79d44a750"></a>
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1fs__handle.html#a1a65884346740af7fb4648c79d44a750">unique_id_type</a> = QUICKCPPLIB_NAMESPACE::integers128::uint128</td></tr>
<tr class="memdesc:a1a65884346740af7fb4648c79d44a750"><td class="mdescLeft"> </td><td class="mdescRight">The unique identifier type used by this handle. <br /></td></tr>
<tr class="separator:a1a65884346740af7fb4648c79d44a750"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:afbebcaabf0282923ff76f6a83d3b4073"><td class="memItemLeft" align="right" valign="top"><a id="afbebcaabf0282923ff76f6a83d3b4073"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1fs__handle.html#afbebcaabf0282923ff76f6a83d3b4073">fs_handle</a> (const <a class="el" href="classllfio__v2__xxx_1_1fs__handle.html">fs_handle</a> &)=delete</td></tr>
<tr class="memdesc:afbebcaabf0282923ff76f6a83d3b4073"><td class="mdescLeft"> </td><td class="mdescRight">No copy construction (use <code>clone()</code>) <br /></td></tr>
<tr class="separator:afbebcaabf0282923ff76f6a83d3b4073"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a09d3ff8122c08cdbcf876f2e4ee6564b"><td class="memItemLeft" align="right" valign="top"><a id="a09d3ff8122c08cdbcf876f2e4ee6564b"></a>
<a class="el" href="classllfio__v2__xxx_1_1fs__handle.html">fs_handle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1fs__handle.html#a09d3ff8122c08cdbcf876f2e4ee6564b">operator=</a> (const <a class="el" href="classllfio__v2__xxx_1_1fs__handle.html">fs_handle</a> &o)=delete</td></tr>
<tr class="memdesc:a09d3ff8122c08cdbcf876f2e4ee6564b"><td class="mdescLeft"> </td><td class="mdescRight">No copy assignment. <br /></td></tr>
<tr class="separator:a09d3ff8122c08cdbcf876f2e4ee6564b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac24ed4cdb96690d7da95cd17b0f3d090"><td class="memItemLeft" align="right" valign="top"><a id="ac24ed4cdb96690d7da95cd17b0f3d090"></a>
dev_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1fs__handle.html#ac24ed4cdb96690d7da95cd17b0f3d090">st_dev</a> () const noexcept</td></tr>
<tr class="memdesc:ac24ed4cdb96690d7da95cd17b0f3d090"><td class="mdescLeft"> </td><td class="mdescRight">Unless <code>flag::disable_safety_unlinks</code> is set, the device id of the file when opened. <br /></td></tr>
<tr class="separator:ac24ed4cdb96690d7da95cd17b0f3d090"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aad6465d30ee438b860ccc59c0e0fc4dc"><td class="memItemLeft" align="right" valign="top"><a id="aad6465d30ee438b860ccc59c0e0fc4dc"></a>
ino_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1fs__handle.html#aad6465d30ee438b860ccc59c0e0fc4dc">st_ino</a> () const noexcept</td></tr>
<tr class="memdesc:aad6465d30ee438b860ccc59c0e0fc4dc"><td class="mdescLeft"> </td><td class="mdescRight">Unless <code>flag::disable_safety_unlinks</code> is set, the inode of the file when opened. When combined with st_dev(), forms a unique identifer on this system. <br /></td></tr>
<tr class="separator:aad6465d30ee438b860ccc59c0e0fc4dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9793fe40564fda2437783488bd51b9f1"><td class="memItemLeft" align="right" valign="top"><a id="a9793fe40564fda2437783488bd51b9f1"></a>
<a class="el" href="classllfio__v2__xxx_1_1fs__handle.html#a1a65884346740af7fb4648c79d44a750">unique_id_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1fs__handle.html#a9793fe40564fda2437783488bd51b9f1">unique_id</a> () const noexcept</td></tr>
<tr class="memdesc:a9793fe40564fda2437783488bd51b9f1"><td class="mdescLeft"> </td><td class="mdescRight">A unique identifier for this handle across the entire system. Can be used in hash tables etc. <br /></td></tr>
<tr class="separator:a9793fe40564fda2437783488bd51b9f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a865caad2f7f4bdf12fb74aabfe3c5ff5"><td class="memItemLeft" align="right" valign="top">virtual result< <a class="el" href="classllfio__v2__xxx_1_1path__handle.html">path_handle</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1fs__handle.html#a865caad2f7f4bdf12fb74aabfe3c5ff5">parent_path_handle</a> (<a class="el" href="structllfio__v2__xxx_1_1deadline.html">deadline</a> d=std::chrono::seconds(30)) const noexcept</td></tr>
<tr class="separator:a865caad2f7f4bdf12fb74aabfe3c5ff5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8700edc9ecd4dd35d5aad7c65dd0eca2"><td class="memItemLeft" align="right" valign="top">virtual result< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1fs__handle.html#a8700edc9ecd4dd35d5aad7c65dd0eca2">relink</a> (const <a class="el" href="classllfio__v2__xxx_1_1path__handle.html">path_handle</a> &base, <a class="el" href="classllfio__v2__xxx_1_1fs__handle.html#abcd8c8171f4e561620864295e8d5879b">path_view_type</a> <a class="el" href="namespacellfio__v2__xxx.html#a49f7bb77eb38fbe1280019225b66b78b">path</a>, bool atomic_replace=true, <a class="el" href="structllfio__v2__xxx_1_1deadline.html">deadline</a> d=std::chrono::seconds(30)) noexcept</td></tr>
<tr class="separator:a8700edc9ecd4dd35d5aad7c65dd0eca2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1dd7923bb65456af4da41ebe7cb84982"><td class="memItemLeft" align="right" valign="top">virtual result< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1fs__handle.html#a1dd7923bb65456af4da41ebe7cb84982">unlink</a> (<a class="el" href="structllfio__v2__xxx_1_1deadline.html">deadline</a> d=std::chrono::seconds(30)) noexcept</td></tr>
<tr class="separator:a1dd7923bb65456af4da41ebe7cb84982"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:adc2b24484565bcb0cf654adf2f732f7e"><td class="memItemLeft" align="right" valign="top"><a id="adc2b24484565bcb0cf654adf2f732f7e"></a>
result< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1fs__handle.html#adc2b24484565bcb0cf654adf2f732f7e">_fetch_inode</a> () const noexcept</td></tr>
<tr class="memdesc:adc2b24484565bcb0cf654adf2f732f7e"><td class="mdescLeft"> </td><td class="mdescRight">Fill in _devid and _inode from the handle via fstat() <br /></td></tr>
<tr class="separator:adc2b24484565bcb0cf654adf2f732f7e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a8b8b7eb5a31bfc94c5bc7eb189fe45"><td class="memItemLeft" align="right" valign="top"><a id="a5a8b8b7eb5a31bfc94c5bc7eb189fe45"></a>
virtual const <a class="el" href="classllfio__v2__xxx_1_1handle.html">handle</a> & </td><td class="memItemRight" valign="bottom"><b>_get_handle</b> () const noexcept=0</td></tr>
<tr class="separator:a5a8b8b7eb5a31bfc94c5bc7eb189fe45"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d2070f6019c86e19de3707bf59ffa97"><td class="memItemLeft" align="right" valign="top"><a id="a1d2070f6019c86e19de3707bf59ffa97"></a>
constexpr </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1fs__handle.html#a1d2070f6019c86e19de3707bf59ffa97">fs_handle</a> ()</td></tr>
<tr class="memdesc:a1d2070f6019c86e19de3707bf59ffa97"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a1d2070f6019c86e19de3707bf59ffa97"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a282f0296cda08ad5ce2f9add2c16a77d"><td class="memItemLeft" align="right" valign="top"><a id="a282f0296cda08ad5ce2f9add2c16a77d"></a>
constexpr </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1fs__handle.html#a282f0296cda08ad5ce2f9add2c16a77d">fs_handle</a> (dev_t devid, ino_t inode)</td></tr>
<tr class="memdesc:a282f0296cda08ad5ce2f9add2c16a77d"><td class="mdescLeft"> </td><td class="mdescRight">Construct a handle. <br /></td></tr>
<tr class="separator:a282f0296cda08ad5ce2f9add2c16a77d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69cc7b561e6ef3a54ccfb2c4743e5c6f"><td class="memItemLeft" align="right" valign="top"><a id="a69cc7b561e6ef3a54ccfb2c4743e5c6f"></a>
constexpr </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1fs__handle.html#a69cc7b561e6ef3a54ccfb2c4743e5c6f">fs_handle</a> (<a class="el" href="classllfio__v2__xxx_1_1fs__handle.html">fs_handle</a> &&o) noexcept</td></tr>
<tr class="memdesc:a69cc7b561e6ef3a54ccfb2c4743e5c6f"><td class="mdescLeft"> </td><td class="mdescRight">Implicit move construction of fs_handle permitted. <br /></td></tr>
<tr class="separator:a69cc7b561e6ef3a54ccfb2c4743e5c6f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaaf55c5a6edb8cde2b8d2fb1f76348ba"><td class="memItemLeft" align="right" valign="top"><a id="aaaf55c5a6edb8cde2b8d2fb1f76348ba"></a>
<a class="el" href="classllfio__v2__xxx_1_1fs__handle.html">fs_handle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1fs__handle.html#aaaf55c5a6edb8cde2b8d2fb1f76348ba">operator=</a> (<a class="el" href="classllfio__v2__xxx_1_1fs__handle.html">fs_handle</a> &&o) noexcept</td></tr>
<tr class="memdesc:aaaf55c5a6edb8cde2b8d2fb1f76348ba"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment of fs_handle permitted. <br /></td></tr>
<tr class="separator:aaaf55c5a6edb8cde2b8d2fb1f76348ba"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a4d20a64cf182162a49962ed25d2126b3"><td class="memItemLeft" align="right" valign="top"><a id="a4d20a64cf182162a49962ed25d2126b3"></a>
dev_t </td><td class="memItemRight" valign="bottom"><b>_devid</b> {0}</td></tr>
<tr class="separator:a4d20a64cf182162a49962ed25d2126b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8454764db3cd47e65ec7853b9cb0b3fa"><td class="memItemLeft" align="right" valign="top"><a id="a8454764db3cd47e65ec7853b9cb0b3fa"></a>
ino_t </td><td class="memItemRight" valign="bottom"><b>_inode</b> {0}</td></tr>
<tr class="separator:a8454764db3cd47e65ec7853b9cb0b3fa"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A handle to something with a device and inode number. </p>
<dl class="section see"><dt>See also</dt><dd><code>algorithm::cached_parent_handle_adapter<T></code> </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a865caad2f7f4bdf12fb74aabfe3c5ff5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a865caad2f7f4bdf12fb74aabfe3c5ff5">◆ </a></span>parent_path_handle()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual result<<a class="el" href="classllfio__v2__xxx_1_1path__handle.html">path_handle</a>> llfio_v2_xxx::fs_handle::parent_path_handle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structllfio__v2__xxx_1_1deadline.html">deadline</a> </td>
<td class="paramname"><em>d</em> = <code>std::chrono::seconds(30)</code></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Obtain a handle to the path <b>currently</b> containing this handle's file entry.</p>
<dl class="section warning"><dt>Warning</dt><dd>This call is <b>racy</b> and can result in the wrong path handle being returned. Note that unless <code>flag::disable_safety_unlinks</code> is set, this implementation opens a <code>path_handle</code> to the source containing directory, then checks if the file entry within has the same inode as the open file handle. It will retry this matching until success until the deadline given.</dd></dl>
<dl class="section user"><dt>Memory Allocations</dt><dd>Calls <code>current_path()</code> and thus is both expensive and calls malloc many times.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><code>algorithm::cached_parent_handle_adapter<T></code> which overrides this with a zero cost implementation, thus making unlinking and relinking very considerably quicker. </dd></dl>
</div>
</div>
<a id="a8700edc9ecd4dd35d5aad7c65dd0eca2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8700edc9ecd4dd35d5aad7c65dd0eca2">◆ </a></span>relink()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual result<void> llfio_v2_xxx::fs_handle::relink </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classllfio__v2__xxx_1_1path__handle.html">path_handle</a> & </td>
<td class="paramname"><em>base</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classllfio__v2__xxx_1_1fs__handle.html#abcd8c8171f4e561620864295e8d5879b">path_view_type</a> </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>atomic_replace</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structllfio__v2__xxx_1_1deadline.html">deadline</a> </td>
<td class="paramname"><em>d</em> = <code>std::chrono::seconds(30)</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Relinks the current path of this open handle to the new path specified. If <code>atomic_replace</code> is true, the relink <b>atomically</b> and silently replaces any item at the new path specified. This operation is both atomic and silent matching POSIX behaviour even on Microsoft Windows where no Win32 API can match POSIX semantics.</p>
<dl class="section warning"><dt>Warning</dt><dd>Some operating systems provide a race free syscall for renaming an open handle (Windows). On all other operating systems this call is <b>racy</b> and can result in the wrong file entry being relinked. Note that unless <code>flag::disable_safety_unlinks</code> is set, this implementation opens a <code>path_handle</code> to the source containing directory first, then checks before relinking that the item about to be relinked has the same inode as the open file handle. It will retry this matching until success until the deadline given. This should prevent most unmalicious accidental loss of data.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">base</td><td>Base for any relative path. </td></tr>
<tr><td class="paramname">path</td><td>The relative or absolute new path to relink to. </td></tr>
<tr><td class="paramname">atomic_replace</td><td>Atomically replace the destination if a file entry already is present there. Choosing false for this will fail if a file entry is already present at the destination, and may not be an atomic operation on some platforms (i.e. both the old and new names may be linked to the same inode for a very short period of time). Windows and recent Linuxes are always atomic. </td></tr>
<tr><td class="paramname">d</td><td>The deadline by which the matching of the containing directory to the open handle's inode must succeed, else <code>errc::timed_out</code> will be returned. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Memory Allocations</dt><dd>Except on platforms with race free syscalls for renaming open handles (Windows), calls <code>current_path()</code> via <code>parent_path_handle()</code> and thus is both expensive and calls malloc many times. </dd></dl>
<p>Reimplemented in <a class="el" href="classllfio__v2__xxx_1_1symlink__handle.html#afea9ef2b36cac3f6dfcae7555ca3303c">llfio_v2_xxx::symlink_handle</a>.</p>
</div>
</div>
<a id="a1dd7923bb65456af4da41ebe7cb84982"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1dd7923bb65456af4da41ebe7cb84982">◆ </a></span>unlink()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual result<void> llfio_v2_xxx::fs_handle::unlink </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structllfio__v2__xxx_1_1deadline.html">deadline</a> </td>
<td class="paramname"><em>d</em> = <code>std::chrono::seconds(30)</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Unlinks the current path of this open handle, causing its entry to immediately disappear from the filing system. On Windows before Windows 10 1709 unless <code>flag::win_disable_unlink_emulation</code> is set, this behaviour is simulated by renaming the file to something random and setting its delete-on-last-close flag. Note that Windows may prevent the renaming of a file in use by another process, if so it will NOT be renamed. After the next handle to that file closes, it will become permanently unopenable by anyone else until the last handle is closed, whereupon the entry will be eventually removed by the operating system.</p>
<dl class="section warning"><dt>Warning</dt><dd>Some operating systems provide a race free syscall for unlinking an open handle (Windows). On all other operating systems this call is <b>racy</b> and can result in the wrong file entry being unlinked. Note that unless <code>flag::disable_safety_unlinks</code> is set, this implementation opens a <code>path_handle</code> to the containing directory first, then checks that the item about to be unlinked has the same inode as the open file handle. It will retry this matching until success until the deadline given. This should prevent most unmalicious accidental loss of data.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">d</td><td>The deadline by which the matching of the containing directory to the open handle's inode must succeed, else <code>errc::timed_out</code> will be returned. </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Memory Allocations</dt><dd>Except on platforms with race free syscalls for unlinking open handles (Windows), calls <code>current_path()</code> and thus is both expensive and calls malloc many times. On Windows, also calls <code>current_path()</code> if <code>flag::disable_safety_unlinks</code> is not set. </dd></dl>
<p>Reimplemented in <a class="el" href="classllfio__v2__xxx_1_1symlink__handle.html#a002c9dab669604d58e08aa8f4dbc99c8">llfio_v2_xxx::symlink_handle</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/llfio/v2.0/<a class="el" href="fs__handle_8hpp.html">fs_handle.hpp</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="namespacellfio__v2__xxx.html">llfio_v2_xxx</a></li><li class="navelem"><a class="el" href="classllfio__v2__xxx_1_1fs__handle.html">fs_handle</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.8.13 </li>
</ul>
</div>
</body>
</html>
|
