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
|
<!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: kvstore_v1_xxx Namespace 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('namespacekvstore__v1__xxx.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="#namespaces">Namespaces</a> |
<a href="#nested-classes">Classes</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">kvstore_v1_xxx Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The kv store namespace.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacekvstore__v1__xxx_1_1traits"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacekvstore__v1__xxx_1_1traits.html">traits</a></td></tr>
<tr class="memdesc:namespacekvstore__v1__xxx_1_1traits"><td class="mdescLeft"> </td><td class="mdescRight">Traits. <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 name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classkvstore__v1__xxx_1_1basic__key__value__store.html">basic_key_value_store</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A possibly hardware-implemented basic key-value store. <a href="classkvstore__v1__xxx_1_1basic__key__value__store.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structkvstore__v1__xxx_1_1basic__key__value__store__info.html">basic_key_value_store_info</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Information about an available key value store implementation. <a href="structkvstore__v1__xxx_1_1basic__key__value__store__info.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 name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ad464f951f0250c13c513f131f4571f2e"><td class="memTemplParams" colspan="2"><a id="ad464f951f0250c13c513f131f4571f2e"></a>
template<class T > </td></tr>
<tr class="memitem:ad464f951f0250c13c513f131f4571f2e"><td class="memTemplItemLeft" align="right" valign="top">using </td><td class="memTemplItemRight" valign="bottom"><b>span</b> = llfio::span< T ></td></tr>
<tr class="separator:ad464f951f0250c13c513f131f4571f2e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb5cffe293f00d60233dfe7b3467b5e9"><td class="memTemplParams" colspan="2"><a id="adb5cffe293f00d60233dfe7b3467b5e9"></a>
template<class T > </td></tr>
<tr class="memitem:adb5cffe293f00d60233dfe7b3467b5e9"><td class="memTemplItemLeft" align="right" valign="top">using </td><td class="memTemplItemRight" valign="bottom"><b>result</b> = llfio::result< T ></td></tr>
<tr class="separator:adb5cffe293f00d60233dfe7b3467b5e9"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a7bc2f2673bddc429b098b16e413deb5f"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacekvstore__v1__xxx.html#a7bc2f2673bddc429b098b16e413deb5f">kvstore_errc</a> { <br />
  <b>success</b> = 0,
<a class="el" href="namespacekvstore__v1__xxx.html#a7bc2f2673bddc429b098b16e413deb5fa4ab2ea6999620ebeb2367865909977ab">kvstore_errc::invalid_uri</a>,
<a class="el" href="namespacekvstore__v1__xxx.html#a7bc2f2673bddc429b098b16e413deb5fa88845d2baf0c5f2c895cd23bd72e3b07">kvstore_errc::unsupported_uri</a>,
<a class="el" href="namespacekvstore__v1__xxx.html#a7bc2f2673bddc429b098b16e413deb5fadfa4eb2805883a2c1653229e6c18aa70">kvstore_errc::unsupported_integrity</a>,
<br />
  <a class="el" href="namespacekvstore__v1__xxx.html#a7bc2f2673bddc429b098b16e413deb5fa203fd50f72dbec98aa499192e1844fc8">kvstore_errc::transaction_aborted_collision</a>
<br />
}</td></tr>
<tr class="separator:a7bc2f2673bddc429b098b16e413deb5f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a6e486d7b17da9677f0218b106b1f3817"><td class="memItemLeft" align="right" valign="top">result< <a class="el" href="classkvstore__v1__xxx_1_1basic__key__value__store.html">basic_key_value_store</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacekvstore__v1__xxx.html#a6e486d7b17da9677f0218b106b1f3817">create_kvstore</a> (const <a class="el" href="classkvstore__v1__xxx_1_1basic__key__value__store.html#a230f8e3e03df31d6647e4544853b1502">basic_key_value_store::uri_type</a> &uri, <a class="el" href="classkvstore__v1__xxx_1_1basic__key__value__store.html#a9b73e1e034a4eaea7c0b83e870772296">basic_key_value_store::size_type</a> key_size, <a class="el" href="classkvstore__v1__xxx_1_1basic__key__value__store.html#afe5e5864b92a51c0ef3ef75f803c2f61">basic_key_value_store::features</a> _features, <a class="el" href="classllfio__v2__xxx_1_1handle.html#aa3930273a2d4cabbac309e0b75701dca">basic_key_value_store::mode</a> _mode=<a class="el" href="classllfio__v2__xxx_1_1handle.html#aa3930273a2d4cabbac309e0b75701dcaaefb2a684e4afb7d55e6147fbe5a332ee">basic_key_value_store::mode::write</a>, <a class="el" href="classllfio__v2__xxx_1_1handle.html#af0b352d0f273ba6fa70c178b2c2fee42">basic_key_value_store::creation</a> _creation=<a class="el" href="classllfio__v2__xxx_1_1handle.html#af0b352d0f273ba6fa70c178b2c2fee42a8f0339e854eb5321306a443ce9199e1d">basic_key_value_store::creation::if_needed</a>, <a class="el" href="classllfio__v2__xxx_1_1handle.html#aecd3a7db6cee3aec07d32fe6f99e6852">basic_key_value_store::caching</a> _caching=<a class="el" href="classllfio__v2__xxx_1_1handle.html#aecd3a7db6cee3aec07d32fe6f99e6852aa181a603769c1f98ad927e7367c7aa51">basic_key_value_store::caching::all</a>)</td></tr>
<tr class="memdesc:a6e486d7b17da9677f0218b106b1f3817"><td class="mdescLeft"> </td><td class="mdescRight">Create a new key value store, or open or truncate an existing key value store, using the given URI. <a href="#a6e486d7b17da9677f0218b106b1f3817">More...</a><br /></td></tr>
<tr class="separator:a6e486d7b17da9677f0218b106b1f3817"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab623a6b882a8f334d0ac43dfbfb72408"><td class="memItemLeft" align="right" valign="top"><a id="ab623a6b882a8f334d0ac43dfbfb72408"></a>
result< <a class="el" href="classkvstore__v1__xxx_1_1basic__key__value__store.html">basic_key_value_store</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacekvstore__v1__xxx.html#ab623a6b882a8f334d0ac43dfbfb72408">open_kvstore</a> (const <a class="el" href="classkvstore__v1__xxx_1_1basic__key__value__store.html#a230f8e3e03df31d6647e4544853b1502">basic_key_value_store::uri_type</a> &uri, <a class="el" href="classllfio__v2__xxx_1_1handle.html#aa3930273a2d4cabbac309e0b75701dca">basic_key_value_store::mode</a> _mode=<a class="el" href="classllfio__v2__xxx_1_1handle.html#aa3930273a2d4cabbac309e0b75701dcaaefb2a684e4afb7d55e6147fbe5a332ee">basic_key_value_store::mode::write</a>, <a class="el" href="classllfio__v2__xxx_1_1handle.html#aecd3a7db6cee3aec07d32fe6f99e6852">basic_key_value_store::caching</a> _caching=<a class="el" href="classllfio__v2__xxx_1_1handle.html#aecd3a7db6cee3aec07d32fe6f99e6852aa181a603769c1f98ad927e7367c7aa51">basic_key_value_store::caching::all</a>)</td></tr>
<tr class="memdesc:ab623a6b882a8f334d0ac43dfbfb72408"><td class="mdescLeft"> </td><td class="mdescRight">Open an existing key value store. A convenience overload for <code>create_kvstore()</code>. <br /></td></tr>
<tr class="separator:ab623a6b882a8f334d0ac43dfbfb72408"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a09144ea19f3c63cd0dab9177ae073447"><td class="memItemLeft" align="right" valign="top"><a id="a09144ea19f3c63cd0dab9177ae073447"></a>
result< span< <a class="el" href="structkvstore__v1__xxx_1_1basic__key__value__store__info.html">basic_key_value_store_info</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacekvstore__v1__xxx.html#a09144ea19f3c63cd0dab9177ae073447">enumerate_kvstores</a> (span< <a class="el" href="structkvstore__v1__xxx_1_1basic__key__value__store__info.html">basic_key_value_store_info</a> > lst)</td></tr>
<tr class="memdesc:a09144ea19f3c63cd0dab9177ae073447"><td class="mdescLeft"> </td><td class="mdescRight">Fill an array with information about all the key value stores available to this process. <br /></td></tr>
<tr class="separator:a09144ea19f3c63cd0dab9177ae073447"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The kv store namespace. </p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a7bc2f2673bddc429b098b16e413deb5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bc2f2673bddc429b098b16e413deb5f">◆ </a></span>kvstore_errc</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespacekvstore__v1__xxx.html#a7bc2f2673bddc429b098b16e413deb5f">kvstore_v1_xxx::kvstore_errc</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The error codes specific to <code>basic_key_value_store</code>. Note the <code>std::errc</code> equivalent codes may also be returned e.g. <code>std::errc::insufficient_disk_space</code>. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a7bc2f2673bddc429b098b16e413deb5fa4ab2ea6999620ebeb2367865909977ab"></a>invalid_uri </td><td class="fielddoc"><p>The URI is not in an understood format. </p>
</td></tr>
<tr><td class="fieldname"><a id="a7bc2f2673bddc429b098b16e413deb5fa88845d2baf0c5f2c895cd23bd72e3b07"></a>unsupported_uri </td><td class="fielddoc"><p>The URI specified an unsupported scheme or mechanism. </p>
</td></tr>
<tr><td class="fieldname"><a id="a7bc2f2673bddc429b098b16e413deb5fadfa4eb2805883a2c1653229e6c18aa70"></a>unsupported_integrity </td><td class="fielddoc"><p>The requested integrity level is not available for this device URI. </p>
</td></tr>
<tr><td class="fieldname"><a id="a7bc2f2673bddc429b098b16e413deb5fa203fd50f72dbec98aa499192e1844fc8"></a>transaction_aborted_collision </td><td class="fielddoc"><p>The transaction could not be committed due to dependent key update. </p>
</td></tr>
</table>
<div class="fragment"><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> {</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  success = 0,</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <a class="code" href="namespacekvstore__v1__xxx.html#a7bc2f2673bddc429b098b16e413deb5fa4ab2ea6999620ebeb2367865909977ab">invalid_uri</a>, <span class="comment">//!< The URI is not in an understood format.</span></div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"></span> <a class="code" href="namespacekvstore__v1__xxx.html#a7bc2f2673bddc429b098b16e413deb5fa88845d2baf0c5f2c895cd23bd72e3b07">unsupported_uri</a>, <span class="comment">//!< The URI specified an unsupported scheme or mechanism.</span></div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"></span> <a class="code" href="namespacekvstore__v1__xxx.html#a7bc2f2673bddc429b098b16e413deb5fadfa4eb2805883a2c1653229e6c18aa70">unsupported_integrity</a>, <span class="comment">//!< The requested integrity level is not available for this device URI.</span></div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"></span> <a class="code" href="namespacekvstore__v1__xxx.html#a7bc2f2673bddc429b098b16e413deb5fa203fd50f72dbec98aa499192e1844fc8">transaction_aborted_collision</a>, <span class="comment">//!< The transaction could not be committed due to dependent key update.</span></div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"></span>};</div><div class="ttc" id="namespacekvstore__v1__xxx_html_a7bc2f2673bddc429b098b16e413deb5fadfa4eb2805883a2c1653229e6c18aa70"><div class="ttname"><a href="namespacekvstore__v1__xxx.html#a7bc2f2673bddc429b098b16e413deb5fadfa4eb2805883a2c1653229e6c18aa70">kvstore_v1_xxx::kvstore_errc::unsupported_integrity</a></div><div class="ttdoc">The requested integrity level is not available for this device URI. </div></div>
<div class="ttc" id="namespacekvstore__v1__xxx_html_a7bc2f2673bddc429b098b16e413deb5fa88845d2baf0c5f2c895cd23bd72e3b07"><div class="ttname"><a href="namespacekvstore__v1__xxx.html#a7bc2f2673bddc429b098b16e413deb5fa88845d2baf0c5f2c895cd23bd72e3b07">kvstore_v1_xxx::kvstore_errc::unsupported_uri</a></div><div class="ttdoc">The URI specified an unsupported scheme or mechanism. </div></div>
<div class="ttc" id="namespacekvstore__v1__xxx_html_a7bc2f2673bddc429b098b16e413deb5fa203fd50f72dbec98aa499192e1844fc8"><div class="ttname"><a href="namespacekvstore__v1__xxx.html#a7bc2f2673bddc429b098b16e413deb5fa203fd50f72dbec98aa499192e1844fc8">kvstore_v1_xxx::kvstore_errc::transaction_aborted_collision</a></div><div class="ttdoc">The transaction could not be committed due to dependent key update. </div></div>
<div class="ttc" id="namespacekvstore__v1__xxx_html_a7bc2f2673bddc429b098b16e413deb5fa4ab2ea6999620ebeb2367865909977ab"><div class="ttname"><a href="namespacekvstore__v1__xxx.html#a7bc2f2673bddc429b098b16e413deb5fa4ab2ea6999620ebeb2367865909977ab">kvstore_v1_xxx::kvstore_errc::invalid_uri</a></div><div class="ttdoc">The URI is not in an understood format. </div></div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a6e486d7b17da9677f0218b106b1f3817"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e486d7b17da9677f0218b106b1f3817">◆ </a></span>create_kvstore()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">result<<a class="el" href="classkvstore__v1__xxx_1_1basic__key__value__store.html">basic_key_value_store</a>> kvstore_v1_xxx::create_kvstore </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classkvstore__v1__xxx_1_1basic__key__value__store.html#a230f8e3e03df31d6647e4544853b1502">basic_key_value_store::uri_type</a> & </td>
<td class="paramname"><em>uri</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classkvstore__v1__xxx_1_1basic__key__value__store.html#a9b73e1e034a4eaea7c0b83e870772296">basic_key_value_store::size_type</a> </td>
<td class="paramname"><em>key_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classkvstore__v1__xxx_1_1basic__key__value__store.html#afe5e5864b92a51c0ef3ef75f803c2f61">basic_key_value_store::features</a> </td>
<td class="paramname"><em>_features</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classllfio__v2__xxx_1_1handle.html#aa3930273a2d4cabbac309e0b75701dca">basic_key_value_store::mode</a> </td>
<td class="paramname"><em>_mode</em> = <code><a class="el" href="classllfio__v2__xxx_1_1handle.html#aa3930273a2d4cabbac309e0b75701dcaaefb2a684e4afb7d55e6147fbe5a332ee">basic_key_value_store::mode::write</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classllfio__v2__xxx_1_1handle.html#af0b352d0f273ba6fa70c178b2c2fee42">basic_key_value_store::creation</a> </td>
<td class="paramname"><em>_creation</em> = <code><a class="el" href="classllfio__v2__xxx_1_1handle.html#af0b352d0f273ba6fa70c178b2c2fee42a8f0339e854eb5321306a443ce9199e1d">basic_key_value_store::creation::if_needed</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classllfio__v2__xxx_1_1handle.html#aecd3a7db6cee3aec07d32fe6f99e6852">basic_key_value_store::caching</a> </td>
<td class="paramname"><em>_caching</em> = <code><a class="el" href="classllfio__v2__xxx_1_1handle.html#aecd3a7db6cee3aec07d32fe6f99e6852aa181a603769c1f98ad927e7367c7aa51">basic_key_value_store::caching::all</a></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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new key value store, or open or truncate an existing key value store, using the given URI. </p>
<p>Query the system and/or process registry of key value store providers for an implementation capable of using a store at <code>uri</code> with the specified key size and features. Guaranteed built-in providers are:</p>
<ul>
<li><p class="startli"><code><a href="file://">file://</a></code> based providers:</p><ul>
<li><code>directory_simple_legacy</code>: A very simple FAT-compatible file based store based on turning the key into hexadecimal, chopping it into chunks of four (<code>0x0000 - 0xffff</code>) such that a hex key <code>0x01234567890abcdef</code>'s value would be stored in the path <code>store/01234/5678/90ab/cdef</code>. Key updates are first written into <code>stage/01234/5678/90ab/cdef</code>, then once fully written they are atomically renamed into <code>store</code>. This store implements only <code>features::stable_values</code>, and is very widely compatible, including with networked drives. Its major downside is potential allocation wastage for many small sized values too big to be stored in the inode, but substantially below the allocation granularity.</li>
<li><code>directory_modern</code>: A much more complex file based store which implements <code>features::history</code>, <code>features::stable_values</code>, <code>features::stable_keys</code>, <code>features::update_deltas</code>, <code>features::atomic_snapshots</code> and <code>features::atomic_transactions</code>.</li>
</ul>
<p class="startli">Inside the file <code>monotonic</code> is a 64 bit monotonic count representing time. Updated values are kept at <code>store/01234/5678/90ab/cdef/values/count</code>, where the monotonic count is atomically incremented every update. <code>store/01234/5678/90ab/cdef/deltas</code> is where 4Kb update deltas are kept if the value is larger than 64Kb. <code>store/01234/5678/90ab/cdef/latest</code> is the count of the latest value, its size, and if deltas need to be applied.</p><ul>
<li><code>single_file</code>: Initially all keys and values are kept in memory. Upon first URI fetch after first creation, a single file is created comprising all the keys and values associatively mapped. This single file can be then be mapped as shared memory into multiple processes, thus enabling multiple concurrent C++ programs to collaborate on a shared store where only values are mutable (and not resizeable). Only one process may pin a value at a time concurrently.</li>
</ul>
</li>
</ul>
<p>URIs may of course specify other sources of key value store than on the file system. Third parties may have registered system-wide implementations available to all programs. The local process may have registered additional implementations as well. </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="namespacekvstore__v1__xxx.html">kvstore_v1_xxx</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>
|
