<!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"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>dmlite: include/dmlite/c/checksums.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">dmlite
 <span id="projectnumber">0.6</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_c6836824bdef15bafab59627cccf2d55.html">dmlite</a></li><li class="navelem"><a class="el" href="dir_d445b4083d3c7359781dc9ee11dbbc0e.html">c</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">checksums.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include <stddef.h></code><br/>
<code>#include "<a class="el" href="io_8h_source.html">io.h</a>"</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for checksums.h:</div>
<div class="dyncontent">
<div class="center"><img src="checksums_8h__incl.png" border="0" usemap="#include_2dmlite_2c_2checksums_8h" alt=""/></div>
<map name="include_2dmlite_2c_2checksums_8h" id="include_2dmlite_2c_2checksums_8h">
<area shape="rect" id="node5" href="io_8h.html" title="C wrapper for I/O interfaces." alt="" coords="453,80,496,107"/><area shape="rect" id="node7" href="dmlite_8h.html" title="C wrapper for DMLite." alt="" coords="346,304,413,331"/><area shape="rect" id="node14" href="any_8h.html" title="Opaque handler to pass different types of values to the API." alt="" coords="551,379,605,405"/><area shape="rect" id="node27" href="pool_8h.html" title="C wrapper for DMLite Pool API." alt="" coords="479,155,536,181"/><area shape="rect" id="node9" href="config_8h.html" title="Header generated by CMake with the build configuration used." alt="" coords="482,453,616,480"/><area shape="rect" id="node11" href="errno_8h.html" title="Error codes." alt="" coords="93,379,221,405"/><area shape="rect" id="node31" href="inode_8h.html" title="C wrapper for DMLite INode API." alt="" coords="580,229,644,256"/><area shape="rect" id="node35" href="utils_8h.html" title="C wrapper for DMLite utils." alt="" coords="682,304,739,331"/></map>
</div>
</div>
<p><a href="checksums_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a0a87db67ee7d98c5663a3ea9beac1cd2"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="checksums_8h.html#a0a87db67ee7d98c5663a3ea9beac1cd2">dmlite_checksum_full_name</a> (const char *shortName, char *output, size_t osize)</td></tr>
<tr class="memdesc:a0a87db67ee7d98c5663a3ea9beac1cd2"><td class="mdescLeft"> </td><td class="mdescRight">Puts into output the full name of the checksum algorithm specified with shortName. <a href="#a0a87db67ee7d98c5663a3ea9beac1cd2">More...</a><br/></td></tr>
<tr class="separator:a0a87db67ee7d98c5663a3ea9beac1cd2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6c009c172b35f080eab5bd0039531ae"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="checksums_8h.html#af6c009c172b35f080eab5bd0039531ae">dmlite_checksum_short_name</a> (const char *longName, char *output, size_t osize)</td></tr>
<tr class="memdesc:af6c009c172b35f080eab5bd0039531ae"><td class="mdescLeft"> </td><td class="mdescRight">Puts into output the short name of the checksum algorithm specified with longName. <a href="#af6c009c172b35f080eab5bd0039531ae">More...</a><br/></td></tr>
<tr class="separator:af6c009c172b35f080eab5bd0039531ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adab5dbf7bb5605ccfad8dc43bb304218"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="checksums_8h.html#adab5dbf7bb5605ccfad8dc43bb304218">dmlite_checksum_md5</a> (<a class="el" href="io_8h.html#a4cbc99198fca60683109a3b6b70e4c50">dmlite_fd</a> *fd, off_t offset, off_t size, char *output, size_t outsize)</td></tr>
<tr class="memdesc:adab5dbf7bb5605ccfad8dc43bb304218"><td class="mdescLeft"> </td><td class="mdescRight">Generated the MD5 checksum of the given file. <a href="#adab5dbf7bb5605ccfad8dc43bb304218">More...</a><br/></td></tr>
<tr class="separator:adab5dbf7bb5605ccfad8dc43bb304218"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a27f2f50a6107bb2066dd5da56ff9fc24"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="checksums_8h.html#a27f2f50a6107bb2066dd5da56ff9fc24">dmlite_checksum_crc32</a> (<a class="el" href="io_8h.html#a4cbc99198fca60683109a3b6b70e4c50">dmlite_fd</a> *fd, off_t offset, off_t size, char *output, size_t outsize)</td></tr>
<tr class="memdesc:a27f2f50a6107bb2066dd5da56ff9fc24"><td class="mdescLeft"> </td><td class="mdescRight">Generated the CRC32 checksum of the given file. <a href="#a27f2f50a6107bb2066dd5da56ff9fc24">More...</a><br/></td></tr>
<tr class="separator:a27f2f50a6107bb2066dd5da56ff9fc24"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa1e6b9f70f7995dc783cf99093203caf"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="checksums_8h.html#aa1e6b9f70f7995dc783cf99093203caf">dmlite_checksum_adler32</a> (<a class="el" href="io_8h.html#a4cbc99198fca60683109a3b6b70e4c50">dmlite_fd</a> *fd, off_t offset, off_t size, char *output, size_t outsize)</td></tr>
<tr class="memdesc:aa1e6b9f70f7995dc783cf99093203caf"><td class="mdescLeft"> </td><td class="mdescRight">Generated the Adler32 checksum of the given file. <a href="#aa1e6b9f70f7995dc783cf99093203caf">More...</a><br/></td></tr>
<tr class="separator:aa1e6b9f70f7995dc783cf99093203caf"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="aa1e6b9f70f7995dc783cf99093203caf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dmlite_checksum_adler32 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="io_8h.html#a4cbc99198fca60683109a3b6b70e4c50">dmlite_fd</a> * </td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">off_t </td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">off_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>outsize</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Generated the Adler32 checksum of the given file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>The file descriptor where to read the data to digest. </td></tr>
<tr><td class="paramname">offset</td><td>Where to start to digest. </td></tr>
<tr><td class="paramname">size</td><td>The number of bytes to digest. 0 means the whole file. </td></tr>
<tr><td class="paramname">output</td><td>Where to put the resulting checksum (in hexadecimal) </td></tr>
<tr><td class="paramname">outsize</td><td>The size of the memory area pointed by output. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, error code otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a27f2f50a6107bb2066dd5da56ff9fc24"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dmlite_checksum_crc32 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="io_8h.html#a4cbc99198fca60683109a3b6b70e4c50">dmlite_fd</a> * </td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">off_t </td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">off_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>outsize</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Generated the CRC32 checksum of the given file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>The file descriptor where to read the data to digest. </td></tr>
<tr><td class="paramname">offset</td><td>Where to start to digest. </td></tr>
<tr><td class="paramname">size</td><td>The number of bytes to digest. 0 means the whole file. </td></tr>
<tr><td class="paramname">output</td><td>Where to put the resulting checksum (in decimal) </td></tr>
<tr><td class="paramname">outsize</td><td>The size of the memory area pointed by output. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, error code otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a0a87db67ee7d98c5663a3ea9beac1cd2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* dmlite_checksum_full_name </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>shortName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>osize</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Puts into output the full name of the checksum algorithm specified with shortName. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">shortName</td><td>The checksum short name (CS, AD, MD) </td></tr>
<tr><td class="paramname">output</td><td>The full name will be put here. </td></tr>
<tr><td class="paramname">osize</td><td>The size of the buffer pointed by output. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The same value as the pointer output </dd></dl>
</div>
</div>
<a class="anchor" id="adab5dbf7bb5605ccfad8dc43bb304218"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dmlite_checksum_md5 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="io_8h.html#a4cbc99198fca60683109a3b6b70e4c50">dmlite_fd</a> * </td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">off_t </td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">off_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>outsize</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Generated the MD5 checksum of the given file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>The file descriptor where to read the data to digest. </td></tr>
<tr><td class="paramname">offset</td><td>Where to start to digest. </td></tr>
<tr><td class="paramname">size</td><td>The number of bytes to digest. 0 means the whole file. </td></tr>
<tr><td class="paramname">output</td><td>Where to put the resulting checksum (in hexadecimal) </td></tr>
<tr><td class="paramname">outsize</td><td>The size of the memory area pointed by output. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, error code otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="af6c009c172b35f080eab5bd0039531ae"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* dmlite_checksum_short_name </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>longName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>osize</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Puts into output the short name of the checksum algorithm specified with longName. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">shortName</td><td>The checksum long name (MD5, ADLER32, ...) </td></tr>
<tr><td class="paramname">output</td><td>The short name will be put here. </td></tr>
<tr><td class="paramname">osize</td><td>The size of the buffer pointed by output. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The same value as the pointer output </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jul 12 2013 07:34:22 for dmlite by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
