<!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"/>
<title>Kyoto Cabinet: kyotocabinet::ProtoDB< STRMAP, DBTYPE > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespacekyotocabinet.html">kyotocabinet</a>::<a class="el" href="classkyotocabinet_1_1ProtoDB.html">ProtoDB</a>
</div>
</div>
<div class="contents">
<h1>kyotocabinet::ProtoDB< STRMAP, DBTYPE > Class Template Reference</h1><!-- doxytag: class="kyotocabinet::ProtoDB" --><!-- doxytag: inherits="kyotocabinet::BasicDB" -->
<p>Prototype implementation of database with STL.
<a href="#_details">More...</a></p>
<p><code>#include <kcprotodb.h></code></p>
<p><a href="classkyotocabinet_1_1ProtoDB-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB_1_1Cursor.html">Cursor</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classkyotocabinet_1_1ProtoDB_1_1Cursor.html" title="Cursor to indicate a record.">Cursor</a> to indicate a record. <a href="classkyotocabinet_1_1ProtoDB_1_1Cursor.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>TranLog</b></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Transaction log. <br/></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#a312487dbc5a546e9919c29eb1110ae24">ProtoDB</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a312487dbc5a546e9919c29eb1110ae24"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#a1889355501d3ca966b668d8cede26c8d">~ProtoDB</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a1889355501d3ca966b668d8cede26c8d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#addce7abcfed926755ca9f889c5b189f5">accept</a> (const char *kbuf, size_t ksiz, <a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html">Visitor</a> *visitor, bool writable=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accept a visitor to a record. <a href="#addce7abcfed926755ca9f889c5b189f5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#abefeb7da685d9c99a7dbc8c88a7b2f49">iterate</a> (<a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html">Visitor</a> *visitor, bool writable=true, <a class="el" href="classkyotocabinet_1_1BasicDB_1_1ProgressChecker.html">ProgressChecker</a> *checker=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate to accept a visitor for each record. <a href="#abefeb7da685d9c99a7dbc8c88a7b2f49"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkyotocabinet_1_1BasicDB_1_1Error.html">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#ab5c7f6f70f64299c74d8855884a3a38a">error</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the last happened error. <a href="#ab5c7f6f70f64299c74d8855884a3a38a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#a3f2d9ff4a9a6702d6d1351a57eef614f">set_error</a> (const char *file, int32_t line, const char *func, <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Error.html#aae81720eb2d1d8be04375d0f766d0fa2">Error::Code</a> code, const char *message)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the error information. <a href="#a3f2d9ff4a9a6702d6d1351a57eef614f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#acc4424e8780abf35cc4ea0e846e12243">open</a> (const std::string &path, uint32_t mode=OWRITER|OCREATE)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a database file. <a href="#acc4424e8780abf35cc4ea0e846e12243"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#a367504a44c75f05fb14647ec692255d5">close</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the database file. <a href="#a367504a44c75f05fb14647ec692255d5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#a0b8e02efc1451ecf5ad610671274de58">synchronize</a> (bool hard=false, <a class="el" href="classkyotocabinet_1_1BasicDB_1_1FileProcessor.html">FileProcessor</a> *proc=NULL, <a class="el" href="classkyotocabinet_1_1BasicDB_1_1ProgressChecker.html">ProgressChecker</a> *checker=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Synchronize updated contents with the file and the device. <a href="#a0b8e02efc1451ecf5ad610671274de58"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#a1988087af949333896cc781804c52623">begin_transaction</a> (bool hard=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Begin transaction. <a href="#a1988087af949333896cc781804c52623"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#a32b269c4a31bee3d2492a339bb9ef335">begin_transaction_try</a> (bool hard=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Try to begin transaction. <a href="#a32b269c4a31bee3d2492a339bb9ef335"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#aa2d052240defd43e541ebb32b96f8b03">end_transaction</a> (bool commit=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">End transaction. <a href="#aa2d052240defd43e541ebb32b96f8b03"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#ad80683dcfde15c43dff973d680889387">clear</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove all records. <a href="#ad80683dcfde15c43dff973d680889387"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#acc978744b73b3d72c725780b2131f322">count</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of records. <a href="#acc978744b73b3d72c725780b2131f322"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#a7f94833d566301c3fecbe2640beb1508">size</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the database file. <a href="#a7f94833d566301c3fecbe2640beb1508"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#a37d77c8cf7cb658983ce9da8cd36c750">path</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the path of the database file. <a href="#a37d77c8cf7cb658983ce9da8cd36c750"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#ac2dd1444ce3263f41f5896f223ffc839">status</a> (std::map< std::string, std::string > *strmap)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the miscellaneous status information. <a href="#ac2dd1444ce3263f41f5896f223ffc839"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkyotocabinet_1_1DB_1_1Cursor.html">Cursor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#a8222c60d8d58fa1a45941507dc9deba1">cursor</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a cursor object. <a href="#a8222c60d8d58fa1a45941507dc9deba1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#ad75d86840e5d9cc5aa38282742ec619b">tune_logger</a> (Logger *logger, uint32_t kinds=Logger::WARN|Logger::ERROR)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the internal logger. <a href="#ad75d86840e5d9cc5aa38282742ec619b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#afd6c178bcce72e75b7f1ade800025b12">tune_meta_trigger</a> (MetaTrigger *trigger)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the internal meta operation trigger. <a href="#afd6c178bcce72e75b7f1ade800025b12"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#a3c25b250ee5a614dd0e4188aafbbda26">opaque</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the opaque data. <a href="#a3c25b250ee5a614dd0e4188aafbbda26"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#aa99741c9c461a66dbc2705fae0b69094">synchronize_opaque</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Synchronize the opaque data. <a href="#aa99741c9c461a66dbc2705fae0b69094"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#abff6bde2ee87dc1444a8e66317aa8c57">report</a> (const char *file, int32_t line, const char *func, <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html#a8b132bbfe38dd885513c2b5e8079c960">Logger::Kind</a> kind, const char *format,...)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Report a message for debugging. <a href="#abff6bde2ee87dc1444a8e66317aa8c57"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#a2a2fb7aa0946c7198d0e517a391fa87c">report_valist</a> (const char *file, int32_t line, const char *func, <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html#a8b132bbfe38dd885513c2b5e8079c960">Logger::Kind</a> kind, const char *format, va_list ap)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Report a message for debugging with variable number of arguments. <a href="#a2a2fb7aa0946c7198d0e517a391fa87c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#ae3f05627e4fd14d89c955e2a1efebc35">report_binary</a> (const char *file, int32_t line, const char *func, <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html#a8b132bbfe38dd885513c2b5e8079c960">Logger::Kind</a> kind, const char *name, const char *buf, size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Report the content of a binary buffer for debugging. <a href="#ae3f05627e4fd14d89c955e2a1efebc35"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1ProtoDB.html#a4de45fca85a6f342a18f626db1b13ea0">trigger_meta</a> (<a class="el" href="classkyotocabinet_1_1BasicDB_1_1MetaTrigger.html#a2f09321f0d989733609843ee94b3db74">MetaTrigger::Kind</a> kind, const char *message)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Trigger a meta database operation. <a href="#a4de45fca85a6f342a18f626db1b13ea0"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class STRMAP, uint8_t DBTYPE><br/>
class kyotocabinet::ProtoDB< STRMAP, DBTYPE ></h3>
<p>Prototype implementation of database with STL. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>STRMAP</em> </td><td>a class compatible with the map class of STL. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>DBTYPE</em> </td><td>the database type number of the class. </td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>This class template is a template for concrete classes which wrap data structures compatible with std::map. Template instance classes can be inherited but overwriting methods is forbidden. The class ProtoHashDB is the instance using std::unordered_map. The class ProtoTreeDB is the instance using std::map. Before every database operation, it is necessary to call the <a class="el" href="classkyotocabinet_1_1BasicDB.html#a6f8ee2f3bde5f5389119fe43696f9bdc" title="Open a database file.">BasicDB::open</a> method in order to open a database file and connect the database object to it. To avoid data missing or corruption, it is important to close every database file by the <a class="el" href="classkyotocabinet_1_1BasicDB.html#a8863ffedb9604742305ece7ccdb23c2a" title="Close the database file.">BasicDB::close</a> method when the database is no longer in use. It is forbidden for multible database objects in a process to open the same database at the same time. It is forbidden to share a database object with child processes. </dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a312487dbc5a546e9919c29eb1110ae24"></a><!-- doxytag: member="kyotocabinet::ProtoDB::ProtoDB" ref="a312487dbc5a546e9919c29eb1110ae24" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::<a class="el" href="classkyotocabinet_1_1ProtoDB.html">ProtoDB</a> </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
</div>
</div>
<a class="anchor" id="a1889355501d3ca966b668d8cede26c8d"></a><!-- doxytag: member="kyotocabinet::ProtoDB::~ProtoDB" ref="a1889355501d3ca966b668d8cede26c8d" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::~<a class="el" href="classkyotocabinet_1_1ProtoDB.html">ProtoDB</a> </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>If the database is not closed, it is closed implicitly. </dd></dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="addce7abcfed926755ca9f889c5b189f5"></a><!-- doxytag: member="kyotocabinet::ProtoDB::accept" ref="addce7abcfed926755ca9f889c5b189f5" args="(const char *kbuf, size_t ksiz, Visitor *visitor, bool writable=true)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::accept </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>kbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>ksiz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html">Visitor</a> * </td>
<td class="paramname"> <em>visitor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>writable</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Accept a visitor to a record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>kbuf</em> </td><td>the pointer to the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ksiz</em> </td><td>the size of the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>visitor</em> </td><td>a visitor object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>writable</em> </td><td>true for writable operation, or false for read-only operation. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>The operation for each record is performed atomically and other threads accessing the same record are blocked. To avoid deadlock, any database operation must not be performed in this function. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1DB.html#a5ae32216900a642c5182e7ee67677467">kyotocabinet::DB</a>.</p>
</div>
</div>
<a class="anchor" id="abefeb7da685d9c99a7dbc8c88a7b2f49"></a><!-- doxytag: member="kyotocabinet::ProtoDB::iterate" ref="abefeb7da685d9c99a7dbc8c88a7b2f49" args="(Visitor *visitor, bool writable=true, ProgressChecker *checker=NULL)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::iterate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html">Visitor</a> * </td>
<td class="paramname"> <em>visitor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>writable</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classkyotocabinet_1_1BasicDB_1_1ProgressChecker.html">ProgressChecker</a> * </td>
<td class="paramname"> <em>checker</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Iterate to accept a visitor for each record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>visitor</em> </td><td>a visitor object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>writable</em> </td><td>true for writable operation, or false for read-only operation. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>checker</em> </td><td>a progress checker object. If it is NULL, no checking is performed. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>The whole iteration is performed atomically and other threads are blocked. To avoid deadlock, any database operation must not be performed in this function. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1BasicDB.html#a809c175a7a69deaa56ed6b9cef9fa973">kyotocabinet::BasicDB</a>.</p>
</div>
</div>
<a class="anchor" id="ab5c7f6f70f64299c74d8855884a3a38a"></a><!-- doxytag: member="kyotocabinet::ProtoDB::error" ref="ab5c7f6f70f64299c74d8855884a3a38a" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classkyotocabinet_1_1BasicDB_1_1Error.html">Error</a> <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::error </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the last happened error. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the last happened error. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1BasicDB.html#a0bbc7d536f192222362a98af678abd16">kyotocabinet::BasicDB</a>.</p>
</div>
</div>
<a class="anchor" id="a3f2d9ff4a9a6702d6d1351a57eef614f"></a><!-- doxytag: member="kyotocabinet::ProtoDB::set_error" ref="a3f2d9ff4a9a6702d6d1351a57eef614f" args="(const char *file, int32_t line, const char *func, Error::Code code, const char *message)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::set_error </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>line</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classkyotocabinet_1_1BasicDB_1_1Error.html#aae81720eb2d1d8be04375d0f766d0fa2">Error::Code</a> </td>
<td class="paramname"> <em>code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>message</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the error information. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>file</em> </td><td>the file name of the program source code. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>line</em> </td><td>the line number of the program source code. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>the function name of the program source code. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>code</em> </td><td>an error code. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>message</em> </td><td>a supplement message. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="acc4424e8780abf35cc4ea0e846e12243"></a><!-- doxytag: member="kyotocabinet::ProtoDB::open" ref="acc4424e8780abf35cc4ea0e846e12243" args="(const std::string &path, uint32_t mode=OWRITER|OCREATE)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::open </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"> <em>mode</em> = <code>OWRITER | OCREATE</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Open a database file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>the path of a database file. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>the connection mode. <a class="el" href="classkyotocabinet_1_1BasicDB.html#a61bb905975c5bb2e9d3d890e65cf664daed0e4bf55347835f8a1c277487767485" title="open as a writer">BasicDB::OWRITER</a> as a writer, <a class="el" href="classkyotocabinet_1_1BasicDB.html#a61bb905975c5bb2e9d3d890e65cf664daac1e035a2264effff6af2f74af4fcf2d" title="open as a reader">BasicDB::OREADER</a> as a reader. The following may be added to the writer mode by bitwise-or: <a class="el" href="classkyotocabinet_1_1BasicDB.html#a61bb905975c5bb2e9d3d890e65cf664dafddaf6558a2c6e43223eb5c6f0d0e240" title="writer creating">BasicDB::OCREATE</a>, which means it creates a new database if the file does not exist, <a class="el" href="classkyotocabinet_1_1BasicDB.html#a61bb905975c5bb2e9d3d890e65cf664da84636e0600e10a014e61abcb53c11d39" title="writer truncating">BasicDB::OTRUNCATE</a>, which means it creates a new database regardless if the file exists, <a class="el" href="classkyotocabinet_1_1BasicDB.html#a61bb905975c5bb2e9d3d890e65cf664da648178f135de06196ff0a59b6d50ffc0" title="auto transaction">BasicDB::OAUTOTRAN</a>, which means each updating operation is performed in implicit transaction, <a class="el" href="classkyotocabinet_1_1BasicDB.html#a61bb905975c5bb2e9d3d890e65cf664dac6952961b46d7d1e71df632e45d80a93" title="auto synchronization">BasicDB::OAUTOSYNC</a>, which means each updating operation is followed by implicit synchronization with the file system. The following may be added to both of the reader mode and the writer mode by bitwise-or: <a class="el" href="classkyotocabinet_1_1BasicDB.html#a61bb905975c5bb2e9d3d890e65cf664da3d1f28662fd5f8c91749aa57cc6f4732" title="open without locking">BasicDB::ONOLOCK</a>, which means it opens the database file without file locking, <a class="el" href="classkyotocabinet_1_1BasicDB.html#a61bb905975c5bb2e9d3d890e65cf664da12f4827b918598179bf05c0797127687" title="lock without blocking">BasicDB::OTRYLOCK</a>, which means locking is performed without blocking, <a class="el" href="classkyotocabinet_1_1BasicDB.html#a61bb905975c5bb2e9d3d890e65cf664da4d79a8f0bc49849b0b434fb4fda4836a" title="open without auto repair">BasicDB::ONOREPAIR</a>, which means the database file is not repaired implicitly even if file destruction is detected. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Every opened database must be closed by the <a class="el" href="classkyotocabinet_1_1BasicDB.html#a8863ffedb9604742305ece7ccdb23c2a" title="Close the database file.">BasicDB::close</a> method when it is no longer in use. It is not allowed for two or more database objects in the same process to keep their connections to the same database file at the same time. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1BasicDB.html#a6f8ee2f3bde5f5389119fe43696f9bdc">kyotocabinet::BasicDB</a>.</p>
</div>
</div>
<a class="anchor" id="a367504a44c75f05fb14647ec692255d5"></a><!-- doxytag: member="kyotocabinet::ProtoDB::close" ref="a367504a44c75f05fb14647ec692255d5" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::close </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Close the database file. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1BasicDB.html#a8863ffedb9604742305ece7ccdb23c2a">kyotocabinet::BasicDB</a>.</p>
</div>
</div>
<a class="anchor" id="a0b8e02efc1451ecf5ad610671274de58"></a><!-- doxytag: member="kyotocabinet::ProtoDB::synchronize" ref="a0b8e02efc1451ecf5ad610671274de58" args="(bool hard=false, FileProcessor *proc=NULL, ProgressChecker *checker=NULL)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::synchronize </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>hard</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classkyotocabinet_1_1BasicDB_1_1FileProcessor.html">FileProcessor</a> * </td>
<td class="paramname"> <em>proc</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classkyotocabinet_1_1BasicDB_1_1ProgressChecker.html">ProgressChecker</a> * </td>
<td class="paramname"> <em>checker</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Synchronize updated contents with the file and the device. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hard</em> </td><td>true for physical synchronization with the device, or false for logical synchronization with the file system. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>proc</em> </td><td>a postprocessor object. If it is NULL, no postprocessing is performed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>checker</em> </td><td>a progress checker object. If it is NULL, no checking is performed. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1BasicDB.html#acf7a2e70f3c1e72be5241f0d611f3d70">kyotocabinet::BasicDB</a>.</p>
</div>
</div>
<a class="anchor" id="a1988087af949333896cc781804c52623"></a><!-- doxytag: member="kyotocabinet::ProtoDB::begin_transaction" ref="a1988087af949333896cc781804c52623" args="(bool hard=false)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::begin_transaction </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>hard</em> = <code>false</code></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Begin transaction. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hard</em> </td><td>true for physical synchronization with the device, or false for logical synchronization with the file system. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1BasicDB.html#a7999f8bf717cfd22ceed42bc54755f00">kyotocabinet::BasicDB</a>.</p>
</div>
</div>
<a class="anchor" id="a32b269c4a31bee3d2492a339bb9ef335"></a><!-- doxytag: member="kyotocabinet::ProtoDB::begin_transaction_try" ref="a32b269c4a31bee3d2492a339bb9ef335" args="(bool hard=false)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::begin_transaction_try </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>hard</em> = <code>false</code></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Try to begin transaction. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hard</em> </td><td>true for physical synchronization with the device, or false for logical synchronization with the file system. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1BasicDB.html#a2cfd959c679cdb7716eab913ac227a6c">kyotocabinet::BasicDB</a>.</p>
</div>
</div>
<a class="anchor" id="aa2d052240defd43e541ebb32b96f8b03"></a><!-- doxytag: member="kyotocabinet::ProtoDB::end_transaction" ref="aa2d052240defd43e541ebb32b96f8b03" args="(bool commit=true)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::end_transaction </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>commit</em> = <code>true</code></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>End transaction. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>commit</em> </td><td>true to commit the transaction, or false to abort the transaction. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1BasicDB.html#a2c32f6bb5544045cf75c5aac1e2d1cac">kyotocabinet::BasicDB</a>.</p>
</div>
</div>
<a class="anchor" id="ad80683dcfde15c43dff973d680889387"></a><!-- doxytag: member="kyotocabinet::ProtoDB::clear" ref="ad80683dcfde15c43dff973d680889387" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::clear </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove all records. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1DB.html#a858d6b76cd5f0a5425a58bfd7b86f2f5">kyotocabinet::DB</a>.</p>
</div>
</div>
<a class="anchor" id="acc978744b73b3d72c725780b2131f322"></a><!-- doxytag: member="kyotocabinet::ProtoDB::count" ref="acc978744b73b3d72c725780b2131f322" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname">int64_t <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::count </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the number of records. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of records, or -1 on failure. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1DB.html#a9ec9e0577dbd25a5cd04dc7509488e8a">kyotocabinet::DB</a>.</p>
</div>
</div>
<a class="anchor" id="a7f94833d566301c3fecbe2640beb1508"></a><!-- doxytag: member="kyotocabinet::ProtoDB::size" ref="a7f94833d566301c3fecbe2640beb1508" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname">int64_t <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::size </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the size of the database file. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the size of the database file in bytes, or -1 on failure. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1BasicDB.html#a573aae4382f43ed148ea035baa4d5f51">kyotocabinet::BasicDB</a>.</p>
</div>
</div>
<a class="anchor" id="a37d77c8cf7cb658983ce9da8cd36c750"></a><!-- doxytag: member="kyotocabinet::ProtoDB::path" ref="a37d77c8cf7cb658983ce9da8cd36c750" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname">std::string <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::path </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the path of the database file. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the path of the database file, or an empty string on failure. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1BasicDB.html#af67d9b139fcfb2fd5bc38d97d7a1856b">kyotocabinet::BasicDB</a>.</p>
</div>
</div>
<a class="anchor" id="ac2dd1444ce3263f41f5896f223ffc839"></a><!-- doxytag: member="kyotocabinet::ProtoDB::status" ref="ac2dd1444ce3263f41f5896f223ffc839" args="(std::map< std::string, std::string > *strmap)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::status </td>
<td>(</td>
<td class="paramtype">std::map< std::string, std::string > * </td>
<td class="paramname"> <em>strmap</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the miscellaneous status information. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strmap</em> </td><td>a string map to contain the result. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1BasicDB.html#ac8807fad23476a2eb7da0c869c546727">kyotocabinet::BasicDB</a>.</p>
</div>
</div>
<a class="anchor" id="a8222c60d8d58fa1a45941507dc9deba1"></a><!-- doxytag: member="kyotocabinet::ProtoDB::cursor" ref="a8222c60d8d58fa1a45941507dc9deba1" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classkyotocabinet_1_1DB_1_1Cursor.html">Cursor</a>* <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::cursor </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a cursor object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the return value is the created cursor object. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Because the object of the return value is allocated by the constructor, it should be released with the delete operator when it is no longer in use. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1BasicDB.html#af270fcad9cfa1dce1b661c33c07165d6">kyotocabinet::BasicDB</a>.</p>
</div>
</div>
<a class="anchor" id="ad75d86840e5d9cc5aa38282742ec619b"></a><!-- doxytag: member="kyotocabinet::ProtoDB::tune_logger" ref="ad75d86840e5d9cc5aa38282742ec619b" args="(Logger *logger, uint32_t kinds=Logger::WARN|Logger::ERROR)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::tune_logger </td>
<td>(</td>
<td class="paramtype">Logger * </td>
<td class="paramname"> <em>logger</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"> <em>kinds</em> = <code>Logger::WARN | Logger::ERROR</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the internal logger. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>logger</em> </td><td>the logger object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kinds</em> </td><td>kinds of logged messages by bitwise-or: <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html#a8b132bbfe38dd885513c2b5e8079c960ac39609b521fbe09d9c41b45561b114b6" title="debugging">Logger::DEBUG</a> for debugging, <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html#a8b132bbfe38dd885513c2b5e8079c960a6bf810306530147894e41520a3d918b9" title="normal information">Logger::INFO</a> for normal information, <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html#a8b132bbfe38dd885513c2b5e8079c960a6a985b6bc2e4f16c3cb394a3de9972dd" title="warning">Logger::WARN</a> for warning, and <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html#a8b132bbfe38dd885513c2b5e8079c960a2fc4717ffb4886b57aa5d343adf7d7ad" title="error">Logger::ERROR</a> for fatal error. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="afd6c178bcce72e75b7f1ade800025b12"></a><!-- doxytag: member="kyotocabinet::ProtoDB::tune_meta_trigger" ref="afd6c178bcce72e75b7f1ade800025b12" args="(MetaTrigger *trigger)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::tune_meta_trigger </td>
<td>(</td>
<td class="paramtype">MetaTrigger * </td>
<td class="paramname"> <em>trigger</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the internal meta operation trigger. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>trigger</em> </td><td>the trigger object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a3c25b250ee5a614dd0e4188aafbbda26"></a><!-- doxytag: member="kyotocabinet::ProtoDB::opaque" ref="a3c25b250ee5a614dd0e4188aafbbda26" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::opaque </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the opaque data. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the pointer to the opaque data region, whose size is 16 bytes. </dd></dl>
</div>
</div>
<a class="anchor" id="aa99741c9c461a66dbc2705fae0b69094"></a><!-- doxytag: member="kyotocabinet::ProtoDB::synchronize_opaque" ref="aa99741c9c461a66dbc2705fae0b69094" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::synchronize_opaque </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Synchronize the opaque data. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="abff6bde2ee87dc1444a8e66317aa8c57"></a><!-- doxytag: member="kyotocabinet::ProtoDB::report" ref="abff6bde2ee87dc1444a8e66317aa8c57" args="(const char *file, int32_t line, const char *func, Logger::Kind kind, const char *format,...)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::report </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>line</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html#a8b132bbfe38dd885513c2b5e8079c960">Logger::Kind</a> </td>
<td class="paramname"> <em>kind</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"> <em>...</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Report a message for debugging. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>file</em> </td><td>the file name of the program source code. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>line</em> </td><td>the line number of the program source code. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>the function name of the program source code. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kind</em> </td><td>the kind of the event. <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html#a8b132bbfe38dd885513c2b5e8079c960ac39609b521fbe09d9c41b45561b114b6" title="debugging">Logger::DEBUG</a> for debugging, <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html#a8b132bbfe38dd885513c2b5e8079c960a6bf810306530147894e41520a3d918b9" title="normal information">Logger::INFO</a> for normal information, <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html#a8b132bbfe38dd885513c2b5e8079c960a6a985b6bc2e4f16c3cb394a3de9972dd" title="warning">Logger::WARN</a> for warning, and <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html#a8b132bbfe38dd885513c2b5e8079c960a2fc4717ffb4886b57aa5d343adf7d7ad" title="error">Logger::ERROR</a> for fatal error. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>the printf-like format string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>...</em> </td><td>used according to the format string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2a2fb7aa0946c7198d0e517a391fa87c"></a><!-- doxytag: member="kyotocabinet::ProtoDB::report_valist" ref="a2a2fb7aa0946c7198d0e517a391fa87c" args="(const char *file, int32_t line, const char *func, Logger::Kind kind, const char *format, va_list ap)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::report_valist </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>line</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html#a8b132bbfe38dd885513c2b5e8079c960">Logger::Kind</a> </td>
<td class="paramname"> <em>kind</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">va_list </td>
<td class="paramname"> <em>ap</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Report a message for debugging with variable number of arguments. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>file</em> </td><td>the file name of the program source code. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>line</em> </td><td>the line number of the program source code. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>the function name of the program source code. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kind</em> </td><td>the kind of the event. <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html#a8b132bbfe38dd885513c2b5e8079c960ac39609b521fbe09d9c41b45561b114b6" title="debugging">Logger::DEBUG</a> for debugging, <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html#a8b132bbfe38dd885513c2b5e8079c960a6bf810306530147894e41520a3d918b9" title="normal information">Logger::INFO</a> for normal information, <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html#a8b132bbfe38dd885513c2b5e8079c960a6a985b6bc2e4f16c3cb394a3de9972dd" title="warning">Logger::WARN</a> for warning, and <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html#a8b132bbfe38dd885513c2b5e8079c960a2fc4717ffb4886b57aa5d343adf7d7ad" title="error">Logger::ERROR</a> for fatal error. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>the printf-like format string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ap</em> </td><td>used according to the format string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae3f05627e4fd14d89c955e2a1efebc35"></a><!-- doxytag: member="kyotocabinet::ProtoDB::report_binary" ref="ae3f05627e4fd14d89c955e2a1efebc35" args="(const char *file, int32_t line, const char *func, Logger::Kind kind, const char *name, const char *buf, size_t size)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::report_binary </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>line</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html#a8b132bbfe38dd885513c2b5e8079c960">Logger::Kind</a> </td>
<td class="paramname"> <em>kind</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Report the content of a binary buffer for debugging. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>file</em> </td><td>the file name of the epicenter. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>line</em> </td><td>the line number of the epicenter. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>the function name of the program source code. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kind</em> </td><td>the kind of the event. <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html#a8b132bbfe38dd885513c2b5e8079c960ac39609b521fbe09d9c41b45561b114b6" title="debugging">Logger::DEBUG</a> for debugging, <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html#a8b132bbfe38dd885513c2b5e8079c960a6bf810306530147894e41520a3d918b9" title="normal information">Logger::INFO</a> for normal information, <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html#a8b132bbfe38dd885513c2b5e8079c960a6a985b6bc2e4f16c3cb394a3de9972dd" title="warning">Logger::WARN</a> for warning, and <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html#a8b132bbfe38dd885513c2b5e8079c960a2fc4717ffb4886b57aa5d343adf7d7ad" title="error">Logger::ERROR</a> for fatal error. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the name of the information. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>the binary buffer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>the size of the binary buffer </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4de45fca85a6f342a18f626db1b13ea0"></a><!-- doxytag: member="kyotocabinet::ProtoDB::trigger_meta" ref="a4de45fca85a6f342a18f626db1b13ea0" args="(MetaTrigger::Kind kind, const char *message)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class STRMAP , uint8_t DBTYPE> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classkyotocabinet_1_1ProtoDB.html">kyotocabinet::ProtoDB</a>< STRMAP, DBTYPE >::trigger_meta </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classkyotocabinet_1_1BasicDB_1_1MetaTrigger.html#a2f09321f0d989733609843ee94b3db74">MetaTrigger::Kind</a> </td>
<td class="paramname"> <em>kind</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>message</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Trigger a meta database operation. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>kind</em> </td><td>the kind of the event. <a class="el" href="classkyotocabinet_1_1BasicDB_1_1MetaTrigger.html#a2f09321f0d989733609843ee94b3db74aba95e02b8d3a3a629b23fbc8b8876930" title="opening">MetaTrigger::OPEN</a> for opening, <a class="el" href="classkyotocabinet_1_1BasicDB_1_1MetaTrigger.html#a2f09321f0d989733609843ee94b3db74a9268399a1c52eb1b1c44418f528dadf1" title="closing">MetaTrigger::CLOSE</a> for closing, <a class="el" href="classkyotocabinet_1_1BasicDB_1_1MetaTrigger.html#a2f09321f0d989733609843ee94b3db74a4a53cf981a346b515fb6c6407c9f35be" title="clearing">MetaTrigger::CLEAR</a> for clearing, <a class="el" href="classkyotocabinet_1_1BasicDB_1_1MetaTrigger.html#a2f09321f0d989733609843ee94b3db74a1cd1473419913853794c7062dc24fcb7" title="iteration">MetaTrigger::ITERATE</a> for iteration, <a class="el" href="classkyotocabinet_1_1BasicDB_1_1MetaTrigger.html#a2f09321f0d989733609843ee94b3db74a6eb9ba3e6a6790bc7e7fe805ef11bd71" title="synchronization">MetaTrigger::SYNCHRONIZE</a> for synchronization, <a class="el" href="classkyotocabinet_1_1BasicDB_1_1MetaTrigger.html#a2f09321f0d989733609843ee94b3db74a4c9183a4ad83ff732018941b800d7179" title="beginning transaction">MetaTrigger::BEGINTRAN</a> for beginning transaction, <a class="el" href="classkyotocabinet_1_1BasicDB_1_1MetaTrigger.html#a2f09321f0d989733609843ee94b3db74a96c4d9b511e7285ce109dc69de1d8681" title="committing transaction">MetaTrigger::COMMITTRAN</a> for committing transaction, <a class="el" href="classkyotocabinet_1_1BasicDB_1_1MetaTrigger.html#a2f09321f0d989733609843ee94b3db74ae57d6836e8d81951ff982294c866e858" title="aborting transaction">MetaTrigger::ABORTTRAN</a> for aborting transaction, and <a class="el" href="classkyotocabinet_1_1BasicDB_1_1MetaTrigger.html#a2f09321f0d989733609843ee94b3db74acde750007f5dc86727b311fafeee6843" title="miscellaneous operation">MetaTrigger::MISC</a> for miscellaneous operations. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>message</em> </td><td>the supplement message. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Sat Dec 11 01:50:27 2010 for Kyoto Cabinet by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
c07f89287b8745f052fcf9bc1067c5c0
>
files
>
107
