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
|
<!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=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>LLFIO: llfio_v2_xxx::algorithm::cached_parent_handle_adapter< T > Class Template 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>
<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 beta</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classllfio__v2__xxx_1_1algorithm_1_1cached__parent__handle__adapter.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-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classllfio__v2__xxx_1_1algorithm_1_1cached__parent__handle__adapter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">llfio_v2_xxx::algorithm::cached_parent_handle_adapter< T > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Adapts any <code>construct()</code>-able implementation to cache its parent directory handle in a process wide cache.
<a href="classllfio__v2__xxx_1_1algorithm_1_1cached__parent__handle__adapter.html#details">More...</a></p>
<p><code>#include "cached_parent.hpp"</code></p>
<div class="dynheader">
Inheritance diagram for llfio_v2_xxx::algorithm::cached_parent_handle_adapter< T >:</div>
<div class="dyncontent">
<div class="center">
<img src="classllfio__v2__xxx_1_1algorithm_1_1cached__parent__handle__adapter.png" alt=""/>
</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:af52438883443a2aadd8f1253187d902b"><td class="memItemLeft" align="right" valign="top"><a id="af52438883443a2aadd8f1253187d902b"></a>
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1algorithm_1_1cached__parent__handle__adapter.html#af52438883443a2aadd8f1253187d902b">adapted_handle_type</a> = T</td></tr>
<tr class="memdesc:af52438883443a2aadd8f1253187d902b"><td class="mdescLeft"> </td><td class="mdescRight">The handle type being adapted. <br /></td></tr>
<tr class="separator:af52438883443a2aadd8f1253187d902b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a72662f106ad3f85bb23aecb56440142b"><td class="memItemLeft" align="right" valign="top"><a id="a72662f106ad3f85bb23aecb56440142b"></a>
using </td><td class="memItemRight" valign="bottom"><b>path_type</b> = typename T::path_type</td></tr>
<tr class="separator:a72662f106ad3f85bb23aecb56440142b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b1e94b8b9887a765f84f835eeb31de8"><td class="memItemLeft" align="right" valign="top"><a id="a1b1e94b8b9887a765f84f835eeb31de8"></a>
using </td><td class="memItemRight" valign="bottom"><b>path_view_type</b> = typename T::path_view_type</td></tr>
<tr class="separator:a1b1e94b8b9887a765f84f835eeb31de8"><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:a2c66194608414dee57df2c92949a92d9"><td class="memItemLeft" align="right" valign="top"><a id="a2c66194608414dee57df2c92949a92d9"></a>
 </td><td class="memItemRight" valign="bottom"><b>cached_parent_handle_adapter</b> (const <a class="el" href="classllfio__v2__xxx_1_1algorithm_1_1cached__parent__handle__adapter.html">cached_parent_handle_adapter</a> &)=default</td></tr>
<tr class="separator:a2c66194608414dee57df2c92949a92d9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a51fe2990ec74c40533997e53a1b8a543"><td class="memItemLeft" align="right" valign="top"><a id="a51fe2990ec74c40533997e53a1b8a543"></a>
 </td><td class="memItemRight" valign="bottom"><b>cached_parent_handle_adapter</b> (<a class="el" href="classllfio__v2__xxx_1_1algorithm_1_1cached__parent__handle__adapter.html">cached_parent_handle_adapter</a> &&)=default</td></tr>
<tr class="separator:a51fe2990ec74c40533997e53a1b8a543"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af5e0564bed2ae3d4c61923724a0b787c"><td class="memItemLeft" align="right" valign="top"><a id="af5e0564bed2ae3d4c61923724a0b787c"></a>
<a class="el" href="classllfio__v2__xxx_1_1algorithm_1_1cached__parent__handle__adapter.html">cached_parent_handle_adapter</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classllfio__v2__xxx_1_1algorithm_1_1cached__parent__handle__adapter.html">cached_parent_handle_adapter</a> &)=default</td></tr>
<tr class="separator:af5e0564bed2ae3d4c61923724a0b787c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af4a59a1fad579f55abed7b85c1511950"><td class="memItemLeft" align="right" valign="top"><a id="af4a59a1fad579f55abed7b85c1511950"></a>
<a class="el" href="classllfio__v2__xxx_1_1algorithm_1_1cached__parent__handle__adapter.html">cached_parent_handle_adapter</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classllfio__v2__xxx_1_1algorithm_1_1cached__parent__handle__adapter.html">cached_parent_handle_adapter</a> &&o) noexcept</td></tr>
<tr class="separator:af4a59a1fad579f55abed7b85c1511950"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d82ccdfb9d9b7cd9fb8893cd12c155d"><td class="memItemLeft" align="right" valign="top"><a id="a1d82ccdfb9d9b7cd9fb8893cd12c155d"></a>
 </td><td class="memItemRight" valign="bottom"><b>cached_parent_handle_adapter</b> (<a class="el" href="classllfio__v2__xxx_1_1algorithm_1_1cached__parent__handle__adapter.html#af52438883443a2aadd8f1253187d902b">adapted_handle_type</a> &&o, const <a class="el" href="classllfio__v2__xxx_1_1path__handle.html">path_handle</a> &base, <a class="el" href="classllfio__v2__xxx_1_1path__view.html">path_view</a> <a class="el" href="namespacellfio__v2__xxx.html#a49f7bb77eb38fbe1280019225b66b78b">path</a>)</td></tr>
<tr class="separator:a1d82ccdfb9d9b7cd9fb8893cd12c155d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7466e1786bba421e2274af9b0b1caa02"><td class="memItemLeft" align="right" valign="top"><a id="a7466e1786bba421e2274af9b0b1caa02"></a>
virtual result< path_type > </td><td class="memItemRight" valign="bottom"><b>current_path</b> () const noexcept override</td></tr>
<tr class="separator:a7466e1786bba421e2274af9b0b1caa02"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5580a0db624b29be0ac6d193daff6abe"><td class="memItemLeft" align="right" valign="top"><a id="a5580a0db624b29be0ac6d193daff6abe"></a>
virtual result< void > </td><td class="memItemRight" valign="bottom"><b>close</b> () noexcept override</td></tr>
<tr class="separator:a5580a0db624b29be0ac6d193daff6abe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee32a4eb83e127d90d1178a23d0570ac"><td class="memItemLeft" align="right" valign="top"><a id="aee32a4eb83e127d90d1178a23d0570ac"></a>
virtual <a class="el" href="structllfio__v2__xxx_1_1native__handle__type.html">native_handle_type</a> </td><td class="memItemRight" valign="bottom"><b>release</b> () noexcept override</td></tr>
<tr class="separator:aee32a4eb83e127d90d1178a23d0570ac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4c28e391f4c7efb2db3e1af989977c71"><td class="memItemLeft" align="right" valign="top"><a id="a4c28e391f4c7efb2db3e1af989977c71"></a>
virtual result< <a class="el" href="classllfio__v2__xxx_1_1path__handle.html">path_handle</a> > </td><td class="memItemRight" valign="bottom"><b>parent_path_handle</b> (<a class="el" href="structllfio__v2__xxx_1_1deadline.html">deadline</a>=std::chrono::seconds(30)) const noexcept override</td></tr>
<tr class="separator:a4c28e391f4c7efb2db3e1af989977c71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a74d004d93961200f030c70c64dc6b82c"><td class="memItemLeft" align="right" valign="top"><a id="a74d004d93961200f030c70c64dc6b82c"></a>
virtual result< void > </td><td class="memItemRight" valign="bottom"><b>relink</b> (const <a class="el" href="classllfio__v2__xxx_1_1path__handle.html">path_handle</a> &base, path_view_type newpath, bool atomic_replace=true, <a class="el" href="structllfio__v2__xxx_1_1deadline.html">deadline</a> d=std::chrono::seconds(30)) noexcept override</td></tr>
<tr class="separator:a74d004d93961200f030c70c64dc6b82c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a08507f188e721ac71b526a08439bf780"><td class="memItemLeft" align="right" valign="top"><a id="a08507f188e721ac71b526a08439bf780"></a>
virtual result< void > </td><td class="memItemRight" valign="bottom"><b>unlink</b> (<a class="el" href="structllfio__v2__xxx_1_1deadline.html">deadline</a> d=std::chrono::seconds(30)) noexcept override</td></tr>
<tr class="separator:a08507f188e721ac71b526a08439bf780"><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:aae3f54ac060e53685a316ecfcfee7edb"><td class="memItemLeft" align="right" valign="top"><a id="aae3f54ac060e53685a316ecfcfee7edb"></a>
detail::cached_path_handle_ptr </td><td class="memItemRight" valign="bottom"><b>_sph</b></td></tr>
<tr class="separator:aae3f54ac060e53685a316ecfcfee7edb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee63eea85c4ac163b97b96b742269e3f"><td class="memItemLeft" align="right" valign="top"><a id="aee63eea85c4ac163b97b96b742269e3f"></a>
filesystem::path </td><td class="memItemRight" valign="bottom"><b>_leafname</b></td></tr>
<tr class="separator:aee63eea85c4ac163b97b96b742269e3f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<class T><br />
class llfio_v2_xxx::algorithm::cached_parent_handle_adapter< T ></h3>
<p>Adapts any <code>construct()</code>-able implementation to cache its parent directory handle in a process wide cache. </p>
<p>For some use cases where one is calling <code>parent_path_handle()</code> or code which calls that function very frequently e.g. calling <code>relink()</code> or <code>unlink()</code> a lot on many files with the same parent directory, having to constantly fetch the current path, open the parent directory and verify inodes becomes unhelpfully inefficient. This adapter keeps a process-wide hash table of directory handles shared between all instances of this adapter, thus making calling <code>parent_path_handle()</code> almost zero cost.</p>
<p>This adapter is of especial use on platforms which do not reliably implement per-fd path tracking for regular files (Apple MacOS, FreeBSD) as <code>current_path()</code> is reimplemented to use the current path of the shared parent directory instead. One loses race freedom within the contained directory, but that is the case on POSIX anyway.</p>
<p>This adapter is also of use on platforms which do not implement path tracking for open handles at all (e.g. Linux without <code>/proc</code> mounted) as the process-wide cache of directory handles retains the path of the directory handle at the time of creation. Third party changes to the part of the filesystem you are working upon will result in the inability to do race free unlinking etc, but if no third party changes are encountered it ought to work well.</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>I have been lazy and used public inheritance from that base i/o handle. I should use protected inheritance to prevent slicing, and expose all the public functions by hand. </dd></dl>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>include/llfio/v2.0/algorithm/handle_adapter/<a class="el" href="cached__parent_8hpp.html">cached_parent.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="namespacellfio__v2__xxx_1_1algorithm.html">algorithm</a></li><li class="navelem"><a class="el" href="classllfio__v2__xxx_1_1algorithm_1_1cached__parent__handle__adapter.html">cached_parent_handle_adapter</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.17 </li>
</ul>
</div>
</body>
</html>
|
