<!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::BasicDB::ProgressChecker 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_1BasicDB.html">BasicDB</a>::<a class="el" href="classkyotocabinet_1_1BasicDB_1_1ProgressChecker.html">ProgressChecker</a> </div> </div> <div class="contents"> <h1>kyotocabinet::BasicDB::ProgressChecker Class Reference</h1><!-- doxytag: class="kyotocabinet::BasicDB::ProgressChecker" --> <p>Interface to check progress status of long process. <a href="#_details">More...</a></p> <p><code>#include <kcdb.h></code></p> <p><a href="classkyotocabinet_1_1BasicDB_1_1ProgressChecker-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1BasicDB_1_1ProgressChecker.html#a813e5376968b897d4b941ce789543a4a">~ProgressChecker</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a813e5376968b897d4b941ce789543a4a"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1BasicDB_1_1ProgressChecker.html#a388b146b59f81ed91a8bd60b45d5acb1">check</a> (const char *name, const char *message, int64_t curcnt, int64_t allcnt)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Check the progress status. <a href="#a388b146b59f81ed91a8bd60b45d5acb1"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Interface to check progress status of long process. </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a813e5376968b897d4b941ce789543a4a"></a><!-- doxytag: member="kyotocabinet::BasicDB::ProgressChecker::~ProgressChecker" ref="a813e5376968b897d4b941ce789543a4a" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual kyotocabinet::BasicDB::ProgressChecker::~ProgressChecker </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Destructor. </p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a388b146b59f81ed91a8bd60b45d5acb1"></a><!-- doxytag: member="kyotocabinet::BasicDB::ProgressChecker::check" ref="a388b146b59f81ed91a8bd60b45d5acb1" args="(const char *name, const char *message, int64_t curcnt, int64_t allcnt)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool kyotocabinet::BasicDB::ProgressChecker::check </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>message</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int64_t </td> <td class="paramname"> <em>curcnt</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int64_t </td> <td class="paramname"> <em>allcnt</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Check the progress status. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the name of the process. </td></tr> <tr><td valign="top"></td><td valign="top"><em>message</em> </td><td>a supplement message. </td></tr> <tr><td valign="top"></td><td valign="top"><em>curcnt</em> </td><td>the count of the current step of the progress, or -1 if not applicable. </td></tr> <tr><td valign="top"></td><td valign="top"><em>allcnt</em> </td><td>the estimation count of all steps of the progress, or -1 if not applicable. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>true to continue the process, or false to stop the process. </dd></dl> </div> </div> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Sat Dec 11 01:50:27 2010 for Kyoto Cabinet by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>