mirror of
https://github.com/berkeleydb/libdb.git
synced 2024-11-17 09:36:24 +00:00
348 lines
12 KiB
HTML
348 lines
12 KiB
HTML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||
<!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/html; charset=UTF-8" />
|
||
<title>Chapter 15. Db_map_base_iterator</title>
|
||
<link rel="stylesheet" href="apiReference.css" type="text/css" />
|
||
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
|
||
<link rel="start" href="index.html" title="Berkeley DB C++ Standard Template Library API Reference" />
|
||
<link rel="up" href="index.html" title="Berkeley DB C++ Standard Template Library API Reference" />
|
||
<link rel="prev" href="db_map_iterators.html" title="Chapter 14. Iterator Classes for db_map and db_multimap" />
|
||
<link rel="next" href="stldb_map_base_iteratordstr_db_map_base_iterator.html" title="~db_map_base_iterator" />
|
||
</head>
|
||
<body>
|
||
<div xmlns="" class="navheader">
|
||
<div class="libver">
|
||
<p>Library Version 11.2.5.2</p>
|
||
</div>
|
||
<table width="100%" summary="Navigation header">
|
||
<tr>
|
||
<th colspan="3" align="center">Chapter 15.
|
||
Db_map_base_iterator </th>
|
||
</tr>
|
||
<tr>
|
||
<td width="20%" align="left"><a accesskey="p" href="db_map_iterators.html">Prev</a> </td>
|
||
<th width="60%" align="center"> </th>
|
||
<td width="20%" align="right"> <a accesskey="n" href="stldb_map_base_iteratordstr_db_map_base_iterator.html">Next</a></td>
|
||
</tr>
|
||
</table>
|
||
<hr />
|
||
</div>
|
||
<div class="chapter" lang="en" xml:lang="en">
|
||
<div class="titlepage">
|
||
<div>
|
||
<div>
|
||
<h2 class="title"><a id="db_map_base_iterator"></a>Chapter 15.
|
||
Db_map_base_iterator </h2>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h4><a id="id3612484"></a> Public Members </h4>
|
||
<div class="informaltable">
|
||
<table border="1" width="80%">
|
||
<colgroup>
|
||
<col />
|
||
<col />
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th>Member</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<a class="xref" href="db_map_base_iterator.html#stldb_map_base_iteratordb_map_base_iterator" title="db_map_base_iterator">db_map_base_iterator</a>
|
||
</td>
|
||
<td>
|
||
<p>Copy constructor. </p> </td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a class="xref" href="stldb_map_base_iteratordstr_db_map_base_iterator.html" title="~db_map_base_iterator">~db_map_base_iterator</a>
|
||
</td>
|
||
<td>
|
||
<p>Destructor. </p> </td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a class="xref" href="stldb_map_base_iteratoroperator_incr.html" title="operator++">operator++</a>
|
||
</td>
|
||
<td>
|
||
<p>Pre-increment. </p> </td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a class="xref" href="stldb_map_base_iteratoroperator_decr.html" title="operator--">operator--</a>
|
||
</td>
|
||
<td>
|
||
<p>Pre-decrement. </p> </td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a class="xref" href="stldb_map_base_iteratoroperator_eq.html" title="operator==">operator==</a>
|
||
</td>
|
||
<td>
|
||
<p>Equal comparison operator. </p> </td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a class="xref" href="stldb_map_base_iteratoroperator_ueq.html" title="operator!=">operator!=</a>
|
||
</td>
|
||
<td>
|
||
<p>Unequal comparison operator. </p> </td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a class="xref" href="stldb_map_base_iteratoroperator__star.html" title="operator *">operator *</a>
|
||
</td>
|
||
<td>
|
||
<p>Dereference operator. </p> </td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a class="xref" href="stldb_map_base_iteratoroperator_arrow.html" title="operator->">operator-></a>
|
||
</td>
|
||
<td>
|
||
<p>Arrow operator. </p> </td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a class="xref" href="stldb_map_base_iteratorrefresh.html" title="refresh">refresh</a>
|
||
</td>
|
||
<td>
|
||
<p>Refresh iterator cached value. </p> </td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a class="xref" href="stldb_map_base_iteratorclose_cursor.html" title="close_cursor">close_cursor</a>
|
||
</td>
|
||
<td>
|
||
<p>Close underlying Berkeley DB cursor of this iterator. </p> </td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a class="xref" href="stldb_map_base_iteratormove_to.html" title="move_to">move_to</a>
|
||
</td>
|
||
<td>
|
||
<p>Iterator movement function. </p> </td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a class="xref" href="stldb_map_base_iteratorset_bulk_buffer.html" title="set_bulk_buffer">set_bulk_buffer</a>
|
||
</td>
|
||
<td>
|
||
<p>Modify bulk buffer size. </p> </td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a class="xref" href="stldb_map_base_iteratorget_bulk_bufsize.html" title="get_bulk_bufsize">get_bulk_bufsize</a>
|
||
</td>
|
||
<td>
|
||
<p>Get bulk retrieval buffer size in bytes. </p> </td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a class="xref" href="stldb_map_base_iteratoroperator_assign.html" title="operator=">operator=</a>
|
||
</td>
|
||
<td>
|
||
<p>Assignment operator. </p> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<h4><a id="id3612747"></a>
|
||
Group</h4>
|
||
<p>
|
||
<a class="xref" href="db_map_iterators.html" title="Chapter 14. Iterator Classes for db_map and db_multimap">
|
||
Iterator Classes for db_map and db_multimap </a>
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<div class="sect1" lang="en" xml:lang="en">
|
||
<div class="titlepage">
|
||
<div>
|
||
<div>
|
||
<h2 class="title" style="clear: both"><a id="stldb_map_base_iteratordb_map_base_iterator"></a>db_map_base_iterator</h2>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect2" lang="en" xml:lang="en">
|
||
<div class="titlepage">
|
||
<div>
|
||
<div>
|
||
<h3 class="title"><a id="stldb_map_base_iteratordb_map_base_iterator_details"></a>Function Details</h3>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<pre class="programlisting">
|
||
db_map_base_iterator(const self &vi)
|
||
</pre>
|
||
<p>Copy constructor. </p>
|
||
<div class="sect3" lang="en" xml:lang="en">
|
||
<div class="titlepage">
|
||
<div>
|
||
<div>
|
||
<h4 class="title"><a id="id3612858"></a>Parameters</h4>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4" lang="en" xml:lang="en">
|
||
<div class="titlepage">
|
||
<div>
|
||
<div>
|
||
<h5 class="title"><a id="id3612835"></a>vi</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>The other iterator of the same type to initialize this. </p>
|
||
</div>
|
||
</div>
|
||
<pre class="programlisting">
|
||
db_map_base_iterator(const base &vi)
|
||
</pre>
|
||
<p>Base copy constructor. </p>
|
||
<div class="sect3" lang="en" xml:lang="en">
|
||
<div class="titlepage">
|
||
<div>
|
||
<div>
|
||
<h4 class="title"><a id="id3613013"></a>Parameters</h4>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4" lang="en" xml:lang="en">
|
||
<div class="titlepage">
|
||
<div>
|
||
<div>
|
||
<h5 class="title"><a id="id3613365"></a>vi</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>Initialize from a base class iterator. </p>
|
||
</div>
|
||
</div>
|
||
<pre class="programlisting">
|
||
db_map_base_iterator(db_container *powner, u_int32_t b_bulk_retrieval=0,
|
||
bool rmw=false, bool directdbget=true,
|
||
bool readonly=false)
|
||
</pre>
|
||
<p>Constructor. </p>
|
||
<div class="sect3" lang="en" xml:lang="en">
|
||
<div class="titlepage">
|
||
<div>
|
||
<div>
|
||
<h4 class="title"><a id="id3613379"></a>Parameters</h4>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4" lang="en" xml:lang="en">
|
||
<div class="titlepage">
|
||
<div>
|
||
<div>
|
||
<h5 class="title"><a id="id3613382"></a>b_bulk_retrieval</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>The bulk read buffer size. 0 means bulk read disabled. </p>
|
||
</div>
|
||
<div class="sect4" lang="en" xml:lang="en">
|
||
<div class="titlepage">
|
||
<div>
|
||
<div>
|
||
<h5 class="title"><a id="id3613397"></a>directdbget</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>Whether do direct database get rather than using key/data values cached in the iterator whenever read. </p>
|
||
</div>
|
||
<div class="sect4" lang="en" xml:lang="en">
|
||
<div class="titlepage">
|
||
<div>
|
||
<div>
|
||
<h5 class="title"><a id="id3613404"></a>readonly</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>Whether open a read only cursor. Only effective when using Berkeley DB Concurrent Data Store. </p>
|
||
</div>
|
||
<div class="sect4" lang="en" xml:lang="en">
|
||
<div class="titlepage">
|
||
<div>
|
||
<div>
|
||
<h5 class="title"><a id="id3613411"></a>powner</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>The container which creates this iterator. </p>
|
||
</div>
|
||
<div class="sect4" lang="en" xml:lang="en">
|
||
<div class="titlepage">
|
||
<div>
|
||
<div>
|
||
<h5 class="title"><a id="id3613417"></a>rmw</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>Whether set DB_RMW flag in underlying cursor. </p>
|
||
</div>
|
||
</div>
|
||
<pre class="programlisting">
|
||
db_map_base_iterator()
|
||
</pre>
|
||
<p>Default constructor, dose not create the cursor for now. </p>
|
||
</div>
|
||
<div class="sect2" lang="en" xml:lang="en">
|
||
<div class="titlepage">
|
||
<div>
|
||
<div>
|
||
<h3 class="title"><a id="id3613069"></a>Group: Constructors and destructor</h3>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>Do not create iterators directly using these constructors, but call <a class="link" href="stldb_mapbegin.html" title="begin">db_map::begin</a>
|
||
or db_multimap_begin to get instances of this class.</p>
|
||
<div class="simplesect" lang="en" xml:lang="en">
|
||
<div class="titlepage"></div>
|
||
<p><a class="link" href="stldb_mapbegin.html" title="begin">db_map::begin()</a>
|
||
<a class="link" href="stldb_mapbegin.html" title="begin">db_multimap::begin()</a>
|
||
</p>
|
||
</div>
|
||
<p>
|
||
</p>
|
||
</div>
|
||
<div class="sect2" lang="en" xml:lang="en">
|
||
<div class="titlepage">
|
||
<div>
|
||
<div>
|
||
<h3 class="title"><a id="id3612836"></a>Class</h3>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>
|
||
<a class="link" href="db_map_base_iterator.html" title="Chapter 15. Db_map_base_iterator">db_map_base_iterator</a>
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="navfooter">
|
||
<hr />
|
||
<table width="100%" summary="Navigation footer">
|
||
<tr>
|
||
<td width="40%" align="left"><a accesskey="p" href="db_map_iterators.html">Prev</a> </td>
|
||
<td width="20%" align="center"> </td>
|
||
<td width="40%" align="right"> <a accesskey="n" href="stldb_map_base_iteratordstr_db_map_base_iterator.html">Next</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td width="40%" align="left" valign="top">Chapter 14.
|
||
Iterator Classes for db_map and db_multimap </td>
|
||
<td width="20%" align="center">
|
||
<a accesskey="h" href="index.html">Home</a>
|
||
</td>
|
||
<td width="40%" align="right" valign="top"> ~db_map_base_iterator</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
</body>
|
||
</html>
|