<!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::CacheDB Class 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_1CacheDB.html">CacheDB</a>
</div>
</div>
<div class="contents">
<h1>kyotocabinet::CacheDB Class Reference</h1><!-- doxytag: class="kyotocabinet::CacheDB" --><!-- doxytag: inherits="kyotocabinet::BasicDB" -->
<p>On-memory hash database with LRU deletion.
<a href="#_details">More...</a></p>
<p><code>#include <kccachedb.h></code></p>
<p><a href="classkyotocabinet_1_1CacheDB-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_1CacheDB_1_1Cursor.html">Cursor</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classkyotocabinet_1_1CacheDB_1_1Cursor.html" title="Cursor to indicate a record.">Cursor</a> to indicate a record. <a href="classkyotocabinet_1_1CacheDB_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>Record</b></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Record data. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><b>Remover</b></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removing visitor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><b>Repeater</b></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Repeating visitor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><b>Setter</b></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Setting visitor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>Slot</b></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Slot table. <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 Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1CacheDB.html#ade67fcf7ec690cbfd0e1758301c45a09">Option</a> { <a class="el" href="classkyotocabinet_1_1CacheDB.html#ade67fcf7ec690cbfd0e1758301c45a09a561369d11f8100f49e495cfc19a6cd67">TSMALL</a> = 1 << 0,
<a class="el" href="classkyotocabinet_1_1CacheDB.html#ade67fcf7ec690cbfd0e1758301c45a09af54cfc57b0e881602b435419abbc12c7">TLINEAR</a> = 1 << 1,
<a class="el" href="classkyotocabinet_1_1CacheDB.html#ade67fcf7ec690cbfd0e1758301c45a09a9b9a0b37a8d27753f36288dc9083f955">TCOMPRESS</a> = 1 << 2
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Tuning options. </p>
<a href="classkyotocabinet_1_1CacheDB.html#ade67fcf7ec690cbfd0e1758301c45a09">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1CacheDB.html#aaf95f2c33218c801b2d7a82c9445f854">Flag</a> { <a class="el" href="classkyotocabinet_1_1CacheDB.html#aaf95f2c33218c801b2d7a82c9445f854a5b6d7bf92c2324bc8f68b48adb6db298">FOPEN</a> = 1 << 0,
<a class="el" href="classkyotocabinet_1_1CacheDB.html#aaf95f2c33218c801b2d7a82c9445f854a1e0c71b6c30761e5fc4149bc800b3ef3">FFATAL</a> = 1 << 1
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Status flags. </p>
<a href="classkyotocabinet_1_1CacheDB.html#aaf95f2c33218c801b2d7a82c9445f854">More...</a><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_1CacheDB.html#ad132e3713e71a4dd434d1e023f9b026c">CacheDB</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#ad132e3713e71a4dd434d1e023f9b026c"></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_1CacheDB.html#a635a471146ab6e6253128ab279df7735">~CacheDB</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a635a471146ab6e6253128ab279df7735"></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_1CacheDB.html#a0a7926656c87cc321b1695ea40cef121">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="#a0a7926656c87cc321b1695ea40cef121"></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_1CacheDB.html#a524e00481d160fb989caf82be2db13fc">accept_bulk</a> (const std::vector< std::string > &keys, <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 multiple records at once. <a href="#a524e00481d160fb989caf82be2db13fc"></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_1CacheDB.html#a668ed0f22f9b9538ffcde8466fc2f5ec">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="#a668ed0f22f9b9538ffcde8466fc2f5ec"></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_1CacheDB.html#a5574b0058edb29a5b696c53ec8b9a7bf">error</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the last happened error. <a href="#a5574b0058edb29a5b696c53ec8b9a7bf"></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_1CacheDB.html#a6ef5142d951c82b5c07c2d59fde70781">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="#a6ef5142d951c82b5c07c2d59fde70781"></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_1CacheDB.html#aff8d30ef3cd6990348c47a88983548bf">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="#aff8d30ef3cd6990348c47a88983548bf"></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_1CacheDB.html#abd976dad39a19f3e9f688d8dd0a63bc0">close</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the database file. <a href="#abd976dad39a19f3e9f688d8dd0a63bc0"></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_1CacheDB.html#a142e5aede110bcdbe8bc5821259738a7">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="#a142e5aede110bcdbe8bc5821259738a7"></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_1CacheDB.html#a4a6206c4b92dddb8a9dde4e582b4af18">begin_transaction</a> (bool hard=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Begin transaction. <a href="#a4a6206c4b92dddb8a9dde4e582b4af18"></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_1CacheDB.html#ae6501a3b39a8c46c0645686fadef5893">begin_transaction_try</a> (bool hard=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Try to begin transaction. <a href="#ae6501a3b39a8c46c0645686fadef5893"></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_1CacheDB.html#a6855f648dc86c9cef76e1200c278a019">end_transaction</a> (bool commit=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">End transaction. <a href="#a6855f648dc86c9cef76e1200c278a019"></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_1CacheDB.html#a426df2e9b1878df1fbe8b102ac0a9ded">clear</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove all records. <a href="#a426df2e9b1878df1fbe8b102ac0a9ded"></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_1CacheDB.html#a41aff5a403500857452361fbfae78a56">count</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of records. <a href="#a41aff5a403500857452361fbfae78a56"></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_1CacheDB.html#a7e6f0a8b3674c463e963a98ff3c5c23d">size</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the database file. <a href="#a7e6f0a8b3674c463e963a98ff3c5c23d"></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_1CacheDB.html#a8e10775100c9577f54c42e4df63db169">path</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the path of the database file. <a href="#a8e10775100c9577f54c42e4df63db169"></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_1CacheDB.html#aa1f1aa4eea1413a010154c1e66507706">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="#aa1f1aa4eea1413a010154c1e66507706"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkyotocabinet_1_1CacheDB_1_1Cursor.html">Cursor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1CacheDB.html#a17e1259ddba5fc7d45185f715394c99b">cursor</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a cursor object. <a href="#a17e1259ddba5fc7d45185f715394c99b"></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_1CacheDB.html#a3b568128b2e2995c26e8e727c1124fe2">tune_logger</a> (<a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html">Logger</a> *logger, uint32_t kinds=Logger::WARN|Logger::ERROR)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the internal logger. <a href="#a3b568128b2e2995c26e8e727c1124fe2"></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_1CacheDB.html#af2e1264b226eede61ce7788ac006ca4b">tune_meta_trigger</a> (<a class="el" href="classkyotocabinet_1_1BasicDB_1_1MetaTrigger.html">MetaTrigger</a> *trigger)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the internal meta operation trigger. <a href="#af2e1264b226eede61ce7788ac006ca4b"></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_1CacheDB.html#abe067496c40fc0e5a6535749eda7ffe4">tune_options</a> (int8_t opts)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the optional features. <a href="#abe067496c40fc0e5a6535749eda7ffe4"></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_1CacheDB.html#acee3916a46ddab369ab2a9c858784973">tune_buckets</a> (int64_t bnum)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the number of buckets of the hash table. <a href="#acee3916a46ddab369ab2a9c858784973"></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_1CacheDB.html#aa4813cbf267a0bc680863198ff015c67">tune_compressor</a> (<a class="el" href="classkyotocabinet_1_1Compressor.html">Compressor</a> *comp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the data compressor. <a href="#aa4813cbf267a0bc680863198ff015c67"></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_1CacheDB.html#aad92a2799a2440a64ad463bea3765228">cap_count</a> (int64_t count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the capacity by record number. <a href="#aad92a2799a2440a64ad463bea3765228"></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_1CacheDB.html#a83391b5fa1fa6903bb043ba3736c2856">cap_size</a> (int64_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the capacity by memory usage. <a href="#a83391b5fa1fa6903bb043ba3736c2856"></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_1CacheDB.html#abdc993678a42c4a05e667c2d8e146019">opaque</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the opaque data. <a href="#abdc993678a42c4a05e667c2d8e146019"></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_1CacheDB.html#a451ff9f111dc181c5baf7cd197b241e0">synchronize_opaque</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Synchronize the opaque data. <a href="#a451ff9f111dc181c5baf7cd197b241e0"></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_1CacheDB.html#a87f53c7968facd542206788ee6936e5c">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="#a87f53c7968facd542206788ee6936e5c"></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_1CacheDB.html#aa6aaa95644b0c7e7850cd382fe784d75">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="#aa6aaa95644b0c7e7850cd382fe784d75"></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_1CacheDB.html#a24d2f8775d9dceeca8f61ac7352e62a7">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="#a24d2f8775d9dceeca8f61ac7352e62a7"></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_1CacheDB.html#aefb90cd4e44726b7c24c1515f71dca47">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="#aefb90cd4e44726b7c24c1515f71dca47"></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_1CacheDB.html#a28bef20cc61def918d9153b3c055fda6">tune_type</a> (int8_t type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the database type. <a href="#a28bef20cc61def918d9153b3c055fda6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1CacheDB.html#abdd2dae45cd11ee1fcbf9bbb9115e8f2">libver</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the library version. <a href="#abdd2dae45cd11ee1fcbf9bbb9115e8f2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1CacheDB.html#abf4ae56bd3fefcd5bc8c467effe63b9d">librev</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the library revision. <a href="#abf4ae56bd3fefcd5bc8c467effe63b9d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1CacheDB.html#a54b967e0492574d2185c7bef4d2a3b6c">fmtver</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the format version. <a href="#a54b967e0492574d2185c7bef4d2a3b6c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1CacheDB.html#a41a78cc517473b0eec96deb9c06d420b">chksum</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the module checksum. <a href="#a41a78cc517473b0eec96deb9c06d420b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1CacheDB.html#af4194f3d3f9ad65df7e4d50234e4d787">type</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the database type. <a href="#af4194f3d3f9ad65df7e4d50234e4d787"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1CacheDB.html#a80b7d910c6d5c96d9c0a77bde73bccd8">opts</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the options. <a href="#a80b7d910c6d5c96d9c0a77bde73bccd8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkyotocabinet_1_1Compressor.html">Compressor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1CacheDB.html#a80d40594e6de1977c3c656aaf9d87ec1">comp</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the data compressor. <a href="#a80d40594e6de1977c3c656aaf9d87ec1"></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_1CacheDB.html#a81a34420d67e0190795eb7b1d2807c9e">recovered</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check whether the database was recovered or not. <a href="#a81a34420d67e0190795eb7b1d2807c9e"></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_1CacheDB.html#acfbcd8dc8bd96bcc2907801c0233b75e">reorganized</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check whether the database was reorganized or not. <a href="#acfbcd8dc8bd96bcc2907801c0233b75e"></a><br/></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa780202cbc01574e5bf9250f34e9ba2a"></a><!-- doxytag: member="kyotocabinet::CacheDB::PlantDB< CacheDB, BasicDB::TYPEGRASS >" ref="aa780202cbc01574e5bf9250f34e9ba2a" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>PlantDB< CacheDB, BasicDB::TYPEGRASS ></b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>On-memory hash database with LRU deletion. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This class is a concrete class to operate a hash database on memory. This class can be inherited but overwriting methods is forbidden. Before every database operation, it is necessary to call the <a class="el" href="classkyotocabinet_1_1CacheDB.html#aff8d30ef3cd6990348c47a88983548bf" title="Open a database file.">CacheDB::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_1CacheDB.html#abd976dad39a19f3e9f688d8dd0a63bc0" title="Close the database file.">CacheDB::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>Member Enumeration Documentation</h2>
<a class="anchor" id="ade67fcf7ec690cbfd0e1758301c45a09"></a><!-- doxytag: member="kyotocabinet::CacheDB::Option" ref="ade67fcf7ec690cbfd0e1758301c45a09" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classkyotocabinet_1_1CacheDB.html#ade67fcf7ec690cbfd0e1758301c45a09">kyotocabinet::CacheDB::Option</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tuning options. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ade67fcf7ec690cbfd0e1758301c45a09a561369d11f8100f49e495cfc19a6cd67"></a><!-- doxytag: member="TSMALL" ref="ade67fcf7ec690cbfd0e1758301c45a09a561369d11f8100f49e495cfc19a6cd67" args="" -->TSMALL</em> </td><td>
<p>dummy for compatibility </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ade67fcf7ec690cbfd0e1758301c45a09af54cfc57b0e881602b435419abbc12c7"></a><!-- doxytag: member="TLINEAR" ref="ade67fcf7ec690cbfd0e1758301c45a09af54cfc57b0e881602b435419abbc12c7" args="" -->TLINEAR</em> </td><td>
<p>dummy for compatibility </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ade67fcf7ec690cbfd0e1758301c45a09a9b9a0b37a8d27753f36288dc9083f955"></a><!-- doxytag: member="TCOMPRESS" ref="ade67fcf7ec690cbfd0e1758301c45a09a9b9a0b37a8d27753f36288dc9083f955" args="" -->TCOMPRESS</em> </td><td>
<p>compress each record </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aaf95f2c33218c801b2d7a82c9445f854"></a><!-- doxytag: member="kyotocabinet::CacheDB::Flag" ref="aaf95f2c33218c801b2d7a82c9445f854" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classkyotocabinet_1_1CacheDB.html#aaf95f2c33218c801b2d7a82c9445f854">kyotocabinet::CacheDB::Flag</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Status flags. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="aaf95f2c33218c801b2d7a82c9445f854a5b6d7bf92c2324bc8f68b48adb6db298"></a><!-- doxytag: member="FOPEN" ref="aaf95f2c33218c801b2d7a82c9445f854a5b6d7bf92c2324bc8f68b48adb6db298" args="" -->FOPEN</em> </td><td>
<p>dummy for compatibility </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aaf95f2c33218c801b2d7a82c9445f854a1e0c71b6c30761e5fc4149bc800b3ef3"></a><!-- doxytag: member="FFATAL" ref="aaf95f2c33218c801b2d7a82c9445f854a1e0c71b6c30761e5fc4149bc800b3ef3" args="" -->FFATAL</em> </td><td>
<p>dummy for compatibility </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad132e3713e71a4dd434d1e023f9b026c"></a><!-- doxytag: member="kyotocabinet::CacheDB::CacheDB" ref="ad132e3713e71a4dd434d1e023f9b026c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kyotocabinet::CacheDB::CacheDB </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="a635a471146ab6e6253128ab279df7735"></a><!-- doxytag: member="kyotocabinet::CacheDB::~CacheDB" ref="a635a471146ab6e6253128ab279df7735" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual kyotocabinet::CacheDB::~CacheDB </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="a0a7926656c87cc321b1695ea40cef121"></a><!-- doxytag: member="kyotocabinet::CacheDB::accept" ref="a0a7926656c87cc321b1695ea40cef121" args="(const char *kbuf, size_t ksiz, Visitor *visitor, bool writable=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::CacheDB::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="a524e00481d160fb989caf82be2db13fc"></a><!-- doxytag: member="kyotocabinet::CacheDB::accept_bulk" ref="a524e00481d160fb989caf82be2db13fc" args="(const std::vector< std::string > &keys, Visitor *visitor, bool writable=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::CacheDB::accept_bulk </td>
<td>(</td>
<td class="paramtype">const std::vector< std::string > & </td>
<td class="paramname"> <em>keys</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 multiple records at once. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>keys</em> </td><td>specifies a string vector of the keys. </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 operations for specified records are performed atomically and other threads accessing the same records 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#a0213c08b8dce9401ca5f5b1bc19aa4a6">kyotocabinet::BasicDB</a>.</p>
</div>
</div>
<a class="anchor" id="a668ed0f22f9b9538ffcde8466fc2f5ec"></a><!-- doxytag: member="kyotocabinet::CacheDB::iterate" ref="a668ed0f22f9b9538ffcde8466fc2f5ec" args="(Visitor *visitor, bool writable=true, ProgressChecker *checker=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::CacheDB::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="a5574b0058edb29a5b696c53ec8b9a7bf"></a><!-- doxytag: member="kyotocabinet::CacheDB::error" ref="a5574b0058edb29a5b696c53ec8b9a7bf" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classkyotocabinet_1_1BasicDB_1_1Error.html">Error</a> kyotocabinet::CacheDB::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="a6ef5142d951c82b5c07c2d59fde70781"></a><!-- doxytag: member="kyotocabinet::CacheDB::set_error" ref="a6ef5142d951c82b5c07c2d59fde70781" args="(const char *file, int32_t line, const char *func, Error::Code code, const char *message)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void kyotocabinet::CacheDB::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="aff8d30ef3cd6990348c47a88983548bf"></a><!-- doxytag: member="kyotocabinet::CacheDB::open" ref="aff8d30ef3cd6990348c47a88983548bf" args="(const std::string &path, uint32_t mode=OWRITER|OCREATE)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::CacheDB::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">CacheDB::OWRITER</a> as a writer, <a class="el" href="classkyotocabinet_1_1BasicDB.html#a61bb905975c5bb2e9d3d890e65cf664daac1e035a2264effff6af2f74af4fcf2d" title="open as a reader">CacheDB::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">CacheDB::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">CacheDB::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">CacheDB::OAUTOTRAN</a>, which means each updating operation is performed in implicit transaction, <a class="el" href="classkyotocabinet_1_1BasicDB.html#a61bb905975c5bb2e9d3d890e65cf664dac6952961b46d7d1e71df632e45d80a93" title="auto synchronization">CacheDB::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">CacheDB::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">CacheDB::OTRYLOCK</a>, which means locking is performed without blocking, <a class="el" href="classkyotocabinet_1_1BasicDB.html#a61bb905975c5bb2e9d3d890e65cf664da4d79a8f0bc49849b0b434fb4fda4836a" title="open without auto repair">CacheDB::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_1CacheDB.html#abd976dad39a19f3e9f688d8dd0a63bc0" title="Close the database file.">CacheDB::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="abd976dad39a19f3e9f688d8dd0a63bc0"></a><!-- doxytag: member="kyotocabinet::CacheDB::close" ref="abd976dad39a19f3e9f688d8dd0a63bc0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::CacheDB::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="a142e5aede110bcdbe8bc5821259738a7"></a><!-- doxytag: member="kyotocabinet::CacheDB::synchronize" ref="a142e5aede110bcdbe8bc5821259738a7" args="(bool hard=false, FileProcessor *proc=NULL, ProgressChecker *checker=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::CacheDB::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="a4a6206c4b92dddb8a9dde4e582b4af18"></a><!-- doxytag: member="kyotocabinet::CacheDB::begin_transaction" ref="a4a6206c4b92dddb8a9dde4e582b4af18" args="(bool hard=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::CacheDB::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="ae6501a3b39a8c46c0645686fadef5893"></a><!-- doxytag: member="kyotocabinet::CacheDB::begin_transaction_try" ref="ae6501a3b39a8c46c0645686fadef5893" args="(bool hard=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::CacheDB::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="a6855f648dc86c9cef76e1200c278a019"></a><!-- doxytag: member="kyotocabinet::CacheDB::end_transaction" ref="a6855f648dc86c9cef76e1200c278a019" args="(bool commit=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::CacheDB::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="a426df2e9b1878df1fbe8b102ac0a9ded"></a><!-- doxytag: member="kyotocabinet::CacheDB::clear" ref="a426df2e9b1878df1fbe8b102ac0a9ded" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::CacheDB::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="a41aff5a403500857452361fbfae78a56"></a><!-- doxytag: member="kyotocabinet::CacheDB::count" ref="a41aff5a403500857452361fbfae78a56" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t kyotocabinet::CacheDB::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="a7e6f0a8b3674c463e963a98ff3c5c23d"></a><!-- doxytag: member="kyotocabinet::CacheDB::size" ref="a7e6f0a8b3674c463e963a98ff3c5c23d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t kyotocabinet::CacheDB::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="a8e10775100c9577f54c42e4df63db169"></a><!-- doxytag: member="kyotocabinet::CacheDB::path" ref="a8e10775100c9577f54c42e4df63db169" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string kyotocabinet::CacheDB::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="aa1f1aa4eea1413a010154c1e66507706"></a><!-- doxytag: member="kyotocabinet::CacheDB::status" ref="aa1f1aa4eea1413a010154c1e66507706" args="(std::map< std::string, std::string > *strmap)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::CacheDB::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="a17e1259ddba5fc7d45185f715394c99b"></a><!-- doxytag: member="kyotocabinet::CacheDB::cursor" ref="a17e1259ddba5fc7d45185f715394c99b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classkyotocabinet_1_1CacheDB_1_1Cursor.html">Cursor</a>* kyotocabinet::CacheDB::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="a3b568128b2e2995c26e8e727c1124fe2"></a><!-- doxytag: member="kyotocabinet::CacheDB::tune_logger" ref="a3b568128b2e2995c26e8e727c1124fe2" args="(Logger *logger, uint32_t kinds=Logger::WARN|Logger::ERROR)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::CacheDB::tune_logger </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classkyotocabinet_1_1BasicDB_1_1Logger.html">Logger</a> * </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><code> [virtual]</code></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>
<p>Implements <a class="el" href="classkyotocabinet_1_1BasicDB.html#a26a13dacff680288b1169a8f27d8a34b">kyotocabinet::BasicDB</a>.</p>
</div>
</div>
<a class="anchor" id="af2e1264b226eede61ce7788ac006ca4b"></a><!-- doxytag: member="kyotocabinet::CacheDB::tune_meta_trigger" ref="af2e1264b226eede61ce7788ac006ca4b" args="(MetaTrigger *trigger)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::CacheDB::tune_meta_trigger </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classkyotocabinet_1_1BasicDB_1_1MetaTrigger.html">MetaTrigger</a> * </td>
<td class="paramname"> <em>trigger</em></td>
<td> ) </td>
<td><code> [virtual]</code></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>
<p>Implements <a class="el" href="classkyotocabinet_1_1BasicDB.html#a574c85f66445ba88d65bd978b63703cc">kyotocabinet::BasicDB</a>.</p>
</div>
</div>
<a class="anchor" id="abe067496c40fc0e5a6535749eda7ffe4"></a><!-- doxytag: member="kyotocabinet::CacheDB::tune_options" ref="abe067496c40fc0e5a6535749eda7ffe4" args="(int8_t opts)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::CacheDB::tune_options </td>
<td>(</td>
<td class="paramtype">int8_t </td>
<td class="paramname"> <em>opts</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the optional features. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>opts</em> </td><td>the optional features by bitwise-or: <a class="el" href="classkyotocabinet_1_1DirDB.html#a8a003b2f5adf2bb8f9e79035f57e7f68a624ae00fb9a368d8932a09a061a636e7" title="compress each record">DirDB::TCOMPRESS</a> to compress each record. </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="acee3916a46ddab369ab2a9c858784973"></a><!-- doxytag: member="kyotocabinet::CacheDB::tune_buckets" ref="acee3916a46ddab369ab2a9c858784973" args="(int64_t bnum)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::CacheDB::tune_buckets </td>
<td>(</td>
<td class="paramtype">int64_t </td>
<td class="paramname"> <em>bnum</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the number of buckets of the hash table. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>bnum</em> </td><td>the number of buckets of the hash table. </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="aa4813cbf267a0bc680863198ff015c67"></a><!-- doxytag: member="kyotocabinet::CacheDB::tune_compressor" ref="aa4813cbf267a0bc680863198ff015c67" args="(Compressor *comp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::CacheDB::tune_compressor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classkyotocabinet_1_1Compressor.html">Compressor</a> * </td>
<td class="paramname"> <em>comp</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the data compressor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>comp</em> </td><td>the data compressor 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="aad92a2799a2440a64ad463bea3765228"></a><!-- doxytag: member="kyotocabinet::CacheDB::cap_count" ref="aad92a2799a2440a64ad463bea3765228" args="(int64_t count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::CacheDB::cap_count </td>
<td>(</td>
<td class="paramtype">int64_t </td>
<td class="paramname"> <em>count</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the capacity by record number. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>the maximum number of records. </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="a83391b5fa1fa6903bb043ba3736c2856"></a><!-- doxytag: member="kyotocabinet::CacheDB::cap_size" ref="a83391b5fa1fa6903bb043ba3736c2856" args="(int64_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::CacheDB::cap_size </td>
<td>(</td>
<td class="paramtype">int64_t </td>
<td class="paramname"> <em>size</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the capacity by memory usage. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>the maximum size of memory usage. </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="abdc993678a42c4a05e667c2d8e146019"></a><!-- doxytag: member="kyotocabinet::CacheDB::opaque" ref="abdc993678a42c4a05e667c2d8e146019" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* kyotocabinet::CacheDB::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="a451ff9f111dc181c5baf7cd197b241e0"></a><!-- doxytag: member="kyotocabinet::CacheDB::synchronize_opaque" ref="a451ff9f111dc181c5baf7cd197b241e0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::CacheDB::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="a87f53c7968facd542206788ee6936e5c"></a><!-- doxytag: member="kyotocabinet::CacheDB::report" ref="a87f53c7968facd542206788ee6936e5c" args="(const char *file, int32_t line, const char *func, Logger::Kind kind, const char *format,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void kyotocabinet::CacheDB::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="aa6aaa95644b0c7e7850cd382fe784d75"></a><!-- doxytag: member="kyotocabinet::CacheDB::report_valist" ref="aa6aaa95644b0c7e7850cd382fe784d75" 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">
<table class="memname">
<tr>
<td class="memname">void kyotocabinet::CacheDB::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="a24d2f8775d9dceeca8f61ac7352e62a7"></a><!-- doxytag: member="kyotocabinet::CacheDB::report_binary" ref="a24d2f8775d9dceeca8f61ac7352e62a7" 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">
<table class="memname">
<tr>
<td class="memname">void kyotocabinet::CacheDB::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="aefb90cd4e44726b7c24c1515f71dca47"></a><!-- doxytag: member="kyotocabinet::CacheDB::trigger_meta" ref="aefb90cd4e44726b7c24c1515f71dca47" args="(MetaTrigger::Kind kind, const char *message)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void kyotocabinet::CacheDB::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>
<a class="anchor" id="a28bef20cc61def918d9153b3c055fda6"></a><!-- doxytag: member="kyotocabinet::CacheDB::tune_type" ref="a28bef20cc61def918d9153b3c055fda6" args="(int8_t type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::CacheDB::tune_type </td>
<td>(</td>
<td class="paramtype">int8_t </td>
<td class="paramname"> <em>type</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the database type. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>the database type. </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="abdd2dae45cd11ee1fcbf9bbb9115e8f2"></a><!-- doxytag: member="kyotocabinet::CacheDB::libver" ref="abdd2dae45cd11ee1fcbf9bbb9115e8f2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t kyotocabinet::CacheDB::libver </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the library version. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the library version, or 0 on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="abf4ae56bd3fefcd5bc8c467effe63b9d"></a><!-- doxytag: member="kyotocabinet::CacheDB::librev" ref="abf4ae56bd3fefcd5bc8c467effe63b9d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t kyotocabinet::CacheDB::librev </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the library revision. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the library revision, or 0 on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a54b967e0492574d2185c7bef4d2a3b6c"></a><!-- doxytag: member="kyotocabinet::CacheDB::fmtver" ref="a54b967e0492574d2185c7bef4d2a3b6c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t kyotocabinet::CacheDB::fmtver </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the format version. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the format version, or 0 on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a41a78cc517473b0eec96deb9c06d420b"></a><!-- doxytag: member="kyotocabinet::CacheDB::chksum" ref="a41a78cc517473b0eec96deb9c06d420b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t kyotocabinet::CacheDB::chksum </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the module checksum. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the module checksum, or 0 on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="af4194f3d3f9ad65df7e4d50234e4d787"></a><!-- doxytag: member="kyotocabinet::CacheDB::type" ref="af4194f3d3f9ad65df7e4d50234e4d787" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t kyotocabinet::CacheDB::type </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the database type. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the database type, or 0 on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a80b7d910c6d5c96d9c0a77bde73bccd8"></a><!-- doxytag: member="kyotocabinet::CacheDB::opts" ref="a80b7d910c6d5c96d9c0a77bde73bccd8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t kyotocabinet::CacheDB::opts </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the options. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the options, or 0 on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a80d40594e6de1977c3c656aaf9d87ec1"></a><!-- doxytag: member="kyotocabinet::CacheDB::comp" ref="a80d40594e6de1977c3c656aaf9d87ec1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classkyotocabinet_1_1Compressor.html">Compressor</a>* kyotocabinet::CacheDB::comp </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the data compressor. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the data compressor, or NULL on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a81a34420d67e0190795eb7b1d2807c9e"></a><!-- doxytag: member="kyotocabinet::CacheDB::recovered" ref="a81a34420d67e0190795eb7b1d2807c9e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::CacheDB::recovered </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check whether the database was recovered or not. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if recovered, or false if not. </dd></dl>
</div>
</div>
<a class="anchor" id="acfbcd8dc8bd96bcc2907801c0233b75e"></a><!-- doxytag: member="kyotocabinet::CacheDB::reorganized" ref="acfbcd8dc8bd96bcc2907801c0233b75e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::CacheDB::reorganized </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check whether the database was reorganized or not. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if recovered, or false if not. </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Jan 3 13:02:27 2011 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>
