<!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::DB::Visitor 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_1DB.html">DB</a>::<a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html">Visitor</a>
</div>
</div>
<div class="contents">
<h1>kyotocabinet::DB::Visitor Class Reference</h1><!-- doxytag: class="kyotocabinet::DB::Visitor" -->
<p>Interface to access a record.
<a href="#_details">More...</a></p>
<p><code>#include <kcdb.h></code></p>
<p><a href="classkyotocabinet_1_1DB_1_1Visitor-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_1DB_1_1Visitor.html#afcb5b4a4c0935a9818e88fe5d6d56b21">~Visitor</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#afcb5b4a4c0935a9818e88fe5d6d56b21"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#a5aea6d12932bbfabdf563fd07bdc2ebb">visit_full</a> (const char *kbuf, size_t ksiz, const char *vbuf, size_t vsiz, size_t *sp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Visit a record. <a href="#a5aea6d12932bbfabdf563fd07bdc2ebb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#a09a935a06d2298f8c9165b825425287a">visit_empty</a> (const char *kbuf, size_t ksiz, size_t *sp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Visit a empty record space. <a href="#a09a935a06d2298f8c9165b825425287a"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#aaf5bcec941a585d3b619151263906b95">NOP</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Special pointer for no operation. <a href="#aaf5bcec941a585d3b619151263906b95"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#a867859f14e90d49802c79e178e68c5c4">REMOVE</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Special pointer to remove the record. <a href="#a867859f14e90d49802c79e178e68c5c4"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Interface to access a record. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="afcb5b4a4c0935a9818e88fe5d6d56b21"></a><!-- doxytag: member="kyotocabinet::DB::Visitor::~Visitor" ref="afcb5b4a4c0935a9818e88fe5d6d56b21" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual kyotocabinet::DB::Visitor::~Visitor </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="a5aea6d12932bbfabdf563fd07bdc2ebb"></a><!-- doxytag: member="kyotocabinet::DB::Visitor::visit_full" ref="a5aea6d12932bbfabdf563fd07bdc2ebb" args="(const char *kbuf, size_t ksiz, const char *vbuf, size_t vsiz, size_t *sp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* kyotocabinet::DB::Visitor::visit_full </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">const char * </td>
<td class="paramname"> <em>vbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>vsiz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t * </td>
<td class="paramname"> <em>sp</em></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>Visit 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>vbuf</em> </td><td>the pointer to the value region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>vsiz</em> </td><td>the size of the value region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sp</em> </td><td>the pointer to the variable into which the size of the region of the return value is assigned. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>If it is the pointer to a region, the value is replaced by the content. If it is <a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#aaf5bcec941a585d3b619151263906b95" title="Special pointer for no operation.">Visitor::NOP</a>, nothing is modified. If it is <a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#a867859f14e90d49802c79e178e68c5c4" title="Special pointer to remove the record.">Visitor::REMOVE</a>, the record is removed. </dd></dl>
</div>
</div>
<a class="anchor" id="a09a935a06d2298f8c9165b825425287a"></a><!-- doxytag: member="kyotocabinet::DB::Visitor::visit_empty" ref="a09a935a06d2298f8c9165b825425287a" args="(const char *kbuf, size_t ksiz, size_t *sp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* kyotocabinet::DB::Visitor::visit_empty </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">size_t * </td>
<td class="paramname"> <em>sp</em></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>Visit a empty record space. </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>sp</em> </td><td>the pointer to the variable into which the size of the region of the return value is assigned. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>If it is the pointer to a region, the value is replaced by the content. If it is <a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#aaf5bcec941a585d3b619151263906b95" title="Special pointer for no operation.">Visitor::NOP</a> or <a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#a867859f14e90d49802c79e178e68c5c4" title="Special pointer to remove the record.">Visitor::REMOVE</a>, nothing is modified. </dd></dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="aaf5bcec941a585d3b619151263906b95"></a><!-- doxytag: member="kyotocabinet::DB::Visitor::NOP" ref="aaf5bcec941a585d3b619151263906b95" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* const <a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#aaf5bcec941a585d3b619151263906b95">kyotocabinet::DB::Visitor::NOP</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Special pointer for no operation. </p>
</div>
</div>
<a class="anchor" id="a867859f14e90d49802c79e178e68c5c4"></a><!-- doxytag: member="kyotocabinet::DB::Visitor::REMOVE" ref="a867859f14e90d49802c79e178e68c5c4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* const <a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#a867859f14e90d49802c79e178e68c5c4">kyotocabinet::DB::Visitor::REMOVE</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Special pointer to remove the record. </p>
</div>
</div>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Sat Dec 11 01:50:27 2010 for Kyoto Cabinet by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
c07f89287b8745f052fcf9bc1067c5c0
>
files
>
61
