<!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: kyotocabinet::Compressor Class 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacekyotocabinet.html">kyotocabinet</a> </li>
<li class="navelem"><a class="el" href="classkyotocabinet_1_1Compressor.html">Compressor</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">kyotocabinet::Compressor Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="kyotocabinet::Compressor" -->
<p>Interfrace of data compression and decompression.
<a href="classkyotocabinet_1_1Compressor.html#details">More...</a></p>
<p><code>#include <kccompress.h></code></p>
<p><a href="classkyotocabinet_1_1Compressor-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
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_1Compressor.html#a28dc2fa48d4facfaecbbeb7ec8f01da4">~Compressor</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a28dc2fa48d4facfaecbbeb7ec8f01da4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1Compressor.html#a8e434846560ed3878dc72c15ee7f66ac">compress</a> (const void *buf, size_t size, size_t *sp)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compress a serial data. <a href="#a8e434846560ed3878dc72c15ee7f66ac"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1Compressor.html#a2f0df4e6cc7d1c7a978e9be1459aa73a">decompress</a> (const void *buf, size_t size, size_t *sp)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decompress a serial data. <a href="#a2f0df4e6cc7d1c7a978e9be1459aa73a"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Interfrace of data compression and decompression. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a28dc2fa48d4facfaecbbeb7ec8f01da4"></a><!-- doxytag: member="kyotocabinet::Compressor::~Compressor" ref="a28dc2fa48d4facfaecbbeb7ec8f01da4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classkyotocabinet_1_1Compressor.html#a28dc2fa48d4facfaecbbeb7ec8f01da4">kyotocabinet::Compressor::~Compressor</a> </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="a8e434846560ed3878dc72c15ee7f66ac"></a><!-- doxytag: member="kyotocabinet::Compressor::compress" ref="a8e434846560ed3878dc72c15ee7f66ac" args="(const void *buf, size_t size, size_t *sp)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual char* <a class="el" href="classkyotocabinet_1_1Compressor.html#a8e434846560ed3878dc72c15ee7f66ac">kyotocabinet::Compressor::compress</a> </td>
<td>(</td>
<td class="paramtype">const void * </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t * </td>
<td class="paramname"><em>sp</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compress a serial data. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>the input buffer. </td></tr>
<tr><td class="paramname">size</td><td>the size of the input buffer. </td></tr>
<tr><td class="paramname">sp</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>the pointer to the result data, or NULL on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Because the region of the return value is allocated with the the new[] operator, it should be released with the delete[] operator when it is no longer in use. </dd></dl>
</div>
</div>
<a class="anchor" id="a2f0df4e6cc7d1c7a978e9be1459aa73a"></a><!-- doxytag: member="kyotocabinet::Compressor::decompress" ref="a2f0df4e6cc7d1c7a978e9be1459aa73a" args="(const void *buf, size_t size, size_t *sp)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual char* <a class="el" href="classkyotocabinet_1_1Compressor.html#a2f0df4e6cc7d1c7a978e9be1459aa73a">kyotocabinet::Compressor::decompress</a> </td>
<td>(</td>
<td class="paramtype">const void * </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t * </td>
<td class="paramname"><em>sp</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decompress a serial data. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>the input buffer. </td></tr>
<tr><td class="paramname">size</td><td>the size of the input buffer. </td></tr>
<tr><td class="paramname">sp</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>the pointer to the result data, or NULL on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Because an additional zero code is appended at the end of the region of the return value, the return value can be treated as a C-style string. Because the region of the return value is allocated with the the new[] operator, it should be released with the delete[] operator when it is no longer in use. </dd></dl>
</div>
</div>
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri May 25 2012 01:21:36 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>