1<?xml version="1.0" encoding="UTF-8" standalone="no"?> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml"> 4 <head> 5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> 6 <title>Chapter 15. Db_map_base_iterator</title> 7 <link rel="stylesheet" href="apiReference.css" type="text/css" /> 8 <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /> 9 <link rel="start" href="index.html" title="Berkeley DB C++ Standard Template Library API Reference" /> 10 <link rel="up" href="index.html" title="Berkeley DB C++ Standard Template Library API Reference" /> 11 <link rel="prev" href="db_map_iterators.html" title="Chapter 14. Iterator Classes for db_map and db_multimap" /> 12 <link rel="next" href="stldb_map_base_iteratordstr_db_map_base_iterator.html" title="~db_map_base_iterator" /> 13 </head> 14 <body> 15 <div class="navheader"> 16 <table width="100%" summary="Navigation header"> 17 <tr> 18 <th colspan="3" align="center">Chapter 15. 19 Db_map_base_iterator </th> 20 </tr> 21 <tr> 22 <td width="20%" align="left"><a accesskey="p" href="db_map_iterators.html">Prev</a> </td> 23 <th width="60%" align="center"> </th> 24 <td width="20%" align="right"> <a accesskey="n" href="stldb_map_base_iteratordstr_db_map_base_iterator.html">Next</a></td> 25 </tr> 26 </table> 27 <hr /> 28 </div> 29 <div class="chapter" lang="en" xml:lang="en"> 30 <div class="titlepage"> 31 <div> 32 <div> 33 <h2 class="title"><a id="db_map_base_iterator"></a>Chapter 15. 34 Db_map_base_iterator </h2> 35 </div> 36 </div> 37 </div> 38 <h4><a id="id1562669"></a> Public Members </h4> 39 <div class="informaltable"> 40 <table border="1" width="80%"> 41 <colgroup> 42 <col /> 43 <col /> 44 </colgroup> 45 <thead> 46 <tr> 47 <th>Member</th> 48 <th>Description</th> 49 </tr> 50 </thead> 51 <tbody> 52 <tr> 53 <td> 54<a class="xref" href="db_map_base_iterator.html#stldb_map_base_iteratordb_map_base_iterator" title="db_map_base_iterator"> 55db_map_base_iterator 56</a> 57</td> 58 <td> 59 <p>Copy constructor. </p> </td> 60 </tr> 61 <tr> 62 <td> 63<a class="xref" href="stldb_map_base_iteratordstr_db_map_base_iterator.html" title="~db_map_base_iterator"> 64~db_map_base_iterator 65</a> 66</td> 67 <td> 68 <p>Destructor. </p> </td> 69 </tr> 70 <tr> 71 <td> 72<a class="xref" href="stldb_map_base_iteratoroperator_incr.html" title="operator++"> 73operator++ 74</a> 75</td> 76 <td> 77 <p>Pre-increment. </p> </td> 78 </tr> 79 <tr> 80 <td> 81<a class="xref" href="stldb_map_base_iteratoroperator_decr.html" title="operator--"> 82operator-- 83</a> 84</td> 85 <td> 86 <p>Pre-decrement. </p> </td> 87 </tr> 88 <tr> 89 <td> 90<a class="xref" href="stldb_map_base_iteratoroperator_eq.html" title="operator=="> 91operator== 92</a> 93</td> 94 <td> 95 <p>Equal comparison operator. </p> </td> 96 </tr> 97 <tr> 98 <td> 99<a class="xref" href="stldb_map_base_iteratoroperator_ueq.html" title="operator!="> 100operator!= 101</a> 102</td> 103 <td> 104 <p>Unequal comparison operator. </p> </td> 105 </tr> 106 <tr> 107 <td> 108<a class="xref" href="stldb_map_base_iteratoroperator__star.html" title="operator *"> 109operator * 110</a> 111</td> 112 <td> 113 <p>Dereference operator. </p> </td> 114 </tr> 115 <tr> 116 <td> 117<a class="xref" href="stldb_map_base_iteratoroperator_arrow.html" title="operator->"> 118operator-> 119</a> 120</td> 121 <td> 122 <p>Arrow operator. </p> </td> 123 </tr> 124 <tr> 125 <td> 126<a class="xref" href="stldb_map_base_iteratorrefresh.html" title="refresh"> 127refresh 128</a> 129</td> 130 <td> 131 <p>Refresh iterator cached value. </p> </td> 132 </tr> 133 <tr> 134 <td> 135<a class="xref" href="stldb_map_base_iteratorclose_cursor.html" title="close_cursor"> 136close_cursor 137</a> 138</td> 139 <td> 140 <p>Close underlying Berkeley DB cursor of this iterator. </p> </td> 141 </tr> 142 <tr> 143 <td> 144<a class="xref" href="stldb_map_base_iteratormove_to.html" title="move_to"> 145move_to 146</a> 147</td> 148 <td> 149 <p>Iterator movement function. </p> </td> 150 </tr> 151 <tr> 152 <td> 153<a class="xref" href="stldb_map_base_iteratorset_bulk_buffer.html" title="set_bulk_buffer"> 154set_bulk_buffer 155</a> 156</td> 157 <td> 158 <p>Modify bulk buffer size. </p> </td> 159 </tr> 160 <tr> 161 <td> 162<a class="xref" href="stldb_map_base_iteratorget_bulk_bufsize.html" title="get_bulk_bufsize"> 163get_bulk_bufsize 164</a> 165</td> 166 <td> 167 <p>Get bulk retrieval buffer size in bytes. </p> </td> 168 </tr> 169 <tr> 170 <td> 171<a class="xref" href="stldb_map_base_iteratoroperator_assign.html" title="operator="> 172operator= 173</a> 174</td> 175 <td> 176 <p>Assignment operator. </p> </td> 177 </tr> 178 </tbody> 179 </table> 180 </div> 181 <h4><a id="id1562975"></a> 182Group</h4> 183 <p> 184<a class="xref" href="db_map_iterators.html" title="Chapter 14. Iterator Classes for db_map and db_multimap"> 185 Iterator Classes for db_map and db_multimap </a> 186</p> 187 <p> 188</p> 189 <div class="sect1" lang="en" xml:lang="en"> 190 <div class="titlepage"> 191 <div> 192 <div> 193 <h2 class="title" style="clear: both"><a id="stldb_map_base_iteratordb_map_base_iterator"></a> 194db_map_base_iterator 195</h2> 196 </div> 197 </div> 198 </div> 199 <div class="sect2" lang="en" xml:lang="en"> 200 <div class="titlepage"> 201 <div> 202 <div> 203 <h3 class="title"><a id="func_details"></a> 204Function Details</h3> 205 </div> 206 </div> 207 </div> 208 <pre class="programlisting"> 209db_map_base_iterator(const self &vi) 210 </pre> 211 <div class="sect3" lang="en" xml:lang="en"> 212 <div class="titlepage"></div> 213 <p>Copy constructor. </p> 214 <p></p> 215 </div> 216 <div class="sect3" lang="en" xml:lang="en"> 217 <div class="titlepage"> 218 <div> 219 <div> 220 <h4 class="title"><a id="id1562917"></a> 221Parameters</h4> 222 </div> 223 </div> 224 </div> 225 <div class="sect4" lang="en" xml:lang="en"> 226 <div class="titlepage"> 227 <div> 228 <div> 229 <h5 class="title"><a id="id1562499"></a> 230 vi </h5> 231 </div> 232 </div> 233 </div> 234 <p>The other iterator of the same type to initialize this. </p> 235 </div> 236 </div> 237 <pre class="programlisting"> 238db_map_base_iterator(const base &vi) 239 </pre> 240 <div class="sect3" lang="en" xml:lang="en"> 241 <div class="titlepage"></div> 242 <p>Base copy constructor. </p> 243 <p></p> 244 </div> 245 <div class="sect3" lang="en" xml:lang="en"> 246 <div class="titlepage"> 247 <div> 248 <div> 249 <h4 class="title"><a id="id1562708"></a> 250Parameters</h4> 251 </div> 252 </div> 253 </div> 254 <div class="sect4" lang="en" xml:lang="en"> 255 <div class="titlepage"> 256 <div> 257 <div> 258 <h5 class="title"><a id="id1562365"></a> 259 vi </h5> 260 </div> 261 </div> 262 </div> 263 <p>Initialize from a base class iterator. </p> 264 </div> 265 </div> 266 <pre class="programlisting"> 267db_map_base_iterator(db_container *powner, u_int32_t b_bulk_retrieval=0, 268 bool rmw=false, bool directdbget=true, 269 bool readonly=false) 270 </pre> 271 <div class="sect3" lang="en" xml:lang="en"> 272 <div class="titlepage"></div> 273 <p>Constructor. </p> 274 <p></p> 275 </div> 276 <div class="sect3" lang="en" xml:lang="en"> 277 <div class="titlepage"> 278 <div> 279 <div> 280 <h4 class="title"><a id="id1562717"></a> 281Parameters</h4> 282 </div> 283 </div> 284 </div> 285 <div class="sect4" lang="en" xml:lang="en"> 286 <div class="titlepage"> 287 <div> 288 <div> 289 <h5 class="title"><a id="id1562855"></a> 290 b_bulk_retrieval </h5> 291 </div> 292 </div> 293 </div> 294 <p>The bulk read buffer size. 0 means bulk read disabled. </p> 295 </div> 296 <div class="sect4" lang="en" xml:lang="en"> 297 <div class="titlepage"> 298 <div> 299 <div> 300 <h5 class="title"><a id="id1562753"></a> 301 directdbget </h5> 302 </div> 303 </div> 304 </div> 305 <p>Whether do direct database get rather than using key/data values cached in the iterator whenever read. </p> 306 </div> 307 <div class="sect4" lang="en" xml:lang="en"> 308 <div class="titlepage"> 309 <div> 310 <div> 311 <h5 class="title"><a id="id1562898"></a> 312 readonly </h5> 313 </div> 314 </div> 315 </div> 316 <p>Whether open a read only cursor. Only effective when using Berkeley DB Concurrent Data Store. </p> 317 </div> 318 <div class="sect4" lang="en" xml:lang="en"> 319 <div class="titlepage"> 320 <div> 321 <div> 322 <h5 class="title"><a id="id1563186"></a> 323 powner </h5> 324 </div> 325 </div> 326 </div> 327 <p>The container which creates this iterator. </p> 328 </div> 329 <div class="sect4" lang="en" xml:lang="en"> 330 <div class="titlepage"> 331 <div> 332 <div> 333 <h5 class="title"><a id="id1562548"></a> 334 rmw </h5> 335 </div> 336 </div> 337 </div> 338 <p>Whether set DB_RMW flag in underlying cursor. </p> 339 </div> 340 </div> 341 <pre class="programlisting"> 342db_map_base_iterator() 343 </pre> 344 <div class="sect3" lang="en" xml:lang="en"> 345 <div class="titlepage"></div> 346 <p>Default constructor, dose not create the cursor for now. </p> 347 </div> 348 </div> 349 <div class="sect2" lang="en" xml:lang="en"> 350 <div class="titlepage"> 351 <div> 352 <div> 353 <h3 class="title"><a id="id1563104"></a> 354Group: Constructors and destructor</h3> 355 </div> 356 </div> 357 </div> 358 <p>Do not create iterators directly using these constructors, but call <a class="link" href="stldb_mapbegin.html" title="begin">db_map::begin</a> 359 or db_multimap_begin to get instances of this class.</p> 360 <div class="simplesect" lang="en" xml:lang="en"> 361 <div class="titlepage"></div> 362 <p><a class="link" href="stldb_mapbegin.html" title="begin">db_map::begin()</a> 363 <a class="link" href="stldb_mapbegin.html" title="begin">db_multimap::begin()</a> 364 </p> 365 </div> 366 <p> 367</p> 368 </div> 369 <div class="sect2" lang="en" xml:lang="en"> 370 <div class="titlepage"> 371 <div> 372 <div> 373 <h3 class="title"><a id="id1563344"></a> 374Class</h3> 375 </div> 376 </div> 377 </div> 378 <p> 379 <a class="link" href="db_map_base_iterator.html" title="Chapter 15. Db_map_base_iterator"> 380 db_map_base_iterator</a> 381 </p> 382 </div> 383 </div> 384 </div> 385 <div class="navfooter"> 386 <hr /> 387 <table width="100%" summary="Navigation footer"> 388 <tr> 389 <td width="40%" align="left"><a accesskey="p" href="db_map_iterators.html">Prev</a> </td> 390 <td width="20%" align="center"> </td> 391 <td width="40%" align="right"> <a accesskey="n" href="stldb_map_base_iteratordstr_db_map_base_iterator.html">Next</a></td> 392 </tr> 393 <tr> 394 <td width="40%" align="left" valign="top">Chapter 14. 395 Iterator Classes for db_map and db_multimap </td> 396 <td width="20%" align="center"> 397 <a accesskey="h" href="index.html">Home</a> 398 </td> 399 <td width="40%" align="right" valign="top"> 400~db_map_base_iterator 401</td> 402 </tr> 403 </table> 404 </div> 405 </body> 406</html> 407