<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <title>Kyoto Cabinet: kcdirdb.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Kyoto Cabinet </div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.7.6.1 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#nested-classes">Classes</a> | <a href="#namespaces">Namespaces</a> | <a href="#define-members">Defines</a> | <a href="#typedef-members">Typedefs</a> </div> <div class="headertitle"> <div class="title">kcdirdb.h File Reference</div> </div> </div><!--header--> <div class="contents"> <p>directory hash database <a href="#details">More...</a></p> <div class="textblock"><code>#include <<a class="el" href="kccommon_8h.html">kccommon.h</a>></code><br/> <code>#include <<a class="el" href="kcutil_8h.html">kcutil.h</a>></code><br/> <code>#include <<a class="el" href="kcthread_8h.html">kcthread.h</a>></code><br/> <code>#include <<a class="el" href="kcfile_8h.html">kcfile.h</a>></code><br/> <code>#include <<a class="el" href="kccompress_8h.html">kccompress.h</a>></code><br/> <code>#include <<a class="el" href="kccompare_8h.html">kccompare.h</a>></code><br/> <code>#include <<a class="el" href="kcmap_8h.html">kcmap.h</a>></code><br/> <code>#include <<a class="el" href="kcregex_8h.html">kcregex.h</a>></code><br/> <code>#include <<a class="el" href="kcdb_8h.html">kcdb.h</a>></code><br/> <code>#include <<a class="el" href="kcplantdb_8h.html">kcplantdb.h</a>></code><br/> </div><table class="memberdecls"> <tr><td colspan="2"><h2><a name="nested-classes"></a> 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_1DirDB.html">kyotocabinet::DirDB</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Directory hash database. <a href="classkyotocabinet_1_1DirDB.html#details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1DirDB_1_1Cursor.html">kyotocabinet::DirDB::Cursor</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classkyotocabinet_1_1DirDB_1_1Cursor.html" title="Cursor to indicate a record.">Cursor</a> to indicate a record. <a href="classkyotocabinet_1_1DirDB_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>kyotocabinet::DirDB::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>kyotocabinet::DirDB::ScopedVisitor</b></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Scoped visitor. <br/></td></tr> <tr><td colspan="2"><h2><a name="namespaces"></a> Namespaces</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacekyotocabinet.html">kyotocabinet</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight"><p>All symbols of Kyoto Cabinet. </p> <br/></td></tr> <tr><td colspan="2"><h2><a name="define-members"></a> Defines</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="kcdirdb_8h.html#a1b7ec59ea8f757c27bd3b95a0d2c8edd">KCDDBMAGICFILE</a>   "__KCDIR__"</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">magic file of the directory <a href="#a1b7ec59ea8f757c27bd3b95a0d2c8edd"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="kcdirdb_8h.html#a984aed13c425e88ac144534f2b9ef148">KCDDBMETAFILE</a>   "__meta__"</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">meta data file of the directory <a href="#a984aed13c425e88ac144534f2b9ef148"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="kcdirdb_8h.html#a91c2e57af9a7aa6af1687ca44441576e">KCDDBOPAQUEFILE</a>   "__opq__"</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">opaque file of the directory <a href="#a91c2e57af9a7aa6af1687ca44441576e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="kcdirdb_8h.html#af04ba50862579cdf88c6e79ebe3a1240">KCDDBATRANPREFIX</a>   "_x"</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">prefix of files for auto transaction <a href="#af04ba50862579cdf88c6e79ebe3a1240"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="kcdirdb_8h.html#afbe30419a413a579c7dcfdc9ec004c5b">KCDDBCHKSUMSEED</a>   "__kyotocabinet__"</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">seed of the module checksum <a href="#afbe30419a413a579c7dcfdc9ec004c5b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="kcdirdb_8h.html#a59dcb061a20bb77e30e0e96d36fe2a51">KCDDBMAGICEOF</a>   "_EOF_"</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">magic data for the end of file <a href="#a59dcb061a20bb77e30e0e96d36fe2a51"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="kcdirdb_8h.html#a6d8417b9a3638da98249f63852f8d3c8">KCDDBWALPATHEXT</a>   "wal"</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">extension of the WAL directory <a href="#a6d8417b9a3638da98249f63852f8d3c8"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="kcdirdb_8h.html#a38acb7049d48f4b37d2d5a4d4a22b6e7">KCDDBTMPPATHEXT</a>   "tmp"</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">extension of the temporary directory <a href="#a38acb7049d48f4b37d2d5a4d4a22b6e7"></a><br/></td></tr> <tr><td colspan="2"><h2><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef PlantDB< DirDB, <br class="typebreak"/> BasicDB::TYPEFOREST > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacekyotocabinet.html#aadca6acd45bcad111229c9f92be7a66b">kyotocabinet::ForestDB</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">An alias of the directory tree database. <a href="#aadca6acd45bcad111229c9f92be7a66b"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>directory hash database </p> </div><hr/><h2>Define Documentation</h2> <a class="anchor" id="a1b7ec59ea8f757c27bd3b95a0d2c8edd"></a><!-- doxytag: member="kcdirdb.h::KCDDBMAGICFILE" ref="a1b7ec59ea8f757c27bd3b95a0d2c8edd" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define <a class="el" href="kcdirdb_8h.html#a1b7ec59ea8f757c27bd3b95a0d2c8edd">KCDDBMAGICFILE</a>   "__KCDIR__"</td> </tr> </table> </div> <div class="memdoc"> <p>magic file of the directory </p> </div> </div> <a class="anchor" id="a984aed13c425e88ac144534f2b9ef148"></a><!-- doxytag: member="kcdirdb.h::KCDDBMETAFILE" ref="a984aed13c425e88ac144534f2b9ef148" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define <a class="el" href="kcdirdb_8h.html#a984aed13c425e88ac144534f2b9ef148">KCDDBMETAFILE</a>   "__meta__"</td> </tr> </table> </div> <div class="memdoc"> <p>meta data file of the directory </p> </div> </div> <a class="anchor" id="a91c2e57af9a7aa6af1687ca44441576e"></a><!-- doxytag: member="kcdirdb.h::KCDDBOPAQUEFILE" ref="a91c2e57af9a7aa6af1687ca44441576e" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define <a class="el" href="kcdirdb_8h.html#a91c2e57af9a7aa6af1687ca44441576e">KCDDBOPAQUEFILE</a>   "__opq__"</td> </tr> </table> </div> <div class="memdoc"> <p>opaque file of the directory </p> </div> </div> <a class="anchor" id="af04ba50862579cdf88c6e79ebe3a1240"></a><!-- doxytag: member="kcdirdb.h::KCDDBATRANPREFIX" ref="af04ba50862579cdf88c6e79ebe3a1240" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define <a class="el" href="kcdirdb_8h.html#af04ba50862579cdf88c6e79ebe3a1240">KCDDBATRANPREFIX</a>   "_x"</td> </tr> </table> </div> <div class="memdoc"> <p>prefix of files for auto transaction </p> </div> </div> <a class="anchor" id="afbe30419a413a579c7dcfdc9ec004c5b"></a><!-- doxytag: member="kcdirdb.h::KCDDBCHKSUMSEED" ref="afbe30419a413a579c7dcfdc9ec004c5b" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define <a class="el" href="kcdirdb_8h.html#afbe30419a413a579c7dcfdc9ec004c5b">KCDDBCHKSUMSEED</a>   "__kyotocabinet__"</td> </tr> </table> </div> <div class="memdoc"> <p>seed of the module checksum </p> </div> </div> <a class="anchor" id="a59dcb061a20bb77e30e0e96d36fe2a51"></a><!-- doxytag: member="kcdirdb.h::KCDDBMAGICEOF" ref="a59dcb061a20bb77e30e0e96d36fe2a51" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define <a class="el" href="kcdirdb_8h.html#a59dcb061a20bb77e30e0e96d36fe2a51">KCDDBMAGICEOF</a>   "_EOF_"</td> </tr> </table> </div> <div class="memdoc"> <p>magic data for the end of file </p> </div> </div> <a class="anchor" id="a6d8417b9a3638da98249f63852f8d3c8"></a><!-- doxytag: member="kcdirdb.h::KCDDBWALPATHEXT" ref="a6d8417b9a3638da98249f63852f8d3c8" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define <a class="el" href="kcdirdb_8h.html#a6d8417b9a3638da98249f63852f8d3c8">KCDDBWALPATHEXT</a>   "wal"</td> </tr> </table> </div> <div class="memdoc"> <p>extension of the WAL directory </p> </div> </div> <a class="anchor" id="a38acb7049d48f4b37d2d5a4d4a22b6e7"></a><!-- doxytag: member="kcdirdb.h::KCDDBTMPPATHEXT" ref="a38acb7049d48f4b37d2d5a4d4a22b6e7" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define <a class="el" href="kcdirdb_8h.html#a38acb7049d48f4b37d2d5a4d4a22b6e7">KCDDBTMPPATHEXT</a>   "tmp"</td> </tr> </table> </div> <div class="memdoc"> <p>extension of the temporary directory </p> </div> </div> </div><!-- contents --> <hr class="footer"/><address class="footer"><small> Generated on Fri May 25 2012 01:21:35 for Kyoto Cabinet by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.7.6.1 </small></address> </body> </html>