<!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 Source File</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="headertitle"> <div class="title">checksums.h</div> </div> </div><!--header--> <div class="contents"> <a href="checksums_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/** @file include/dmlite/c/utils.h</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * @brief C wrapper for DMLite utils.</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * @author Alejandro Álvarez Ayllon <aalvarez@cern.ch></span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> */</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#ifndef DMLITE_CHECKSUMS_H</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor"></span><span class="preprocessor">#define DMLITE_CHECKSUMS_H</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <stddef.h></span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "<a class="code" href="io_8h.html" title="C wrapper for I/O interfaces.">io.h</a>"</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">/**</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * @brief Puts into output the full name of the checksum algorithm</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * specified with shortName.</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * @param shortName The checksum short name (CS, AD, MD)</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * @param output The full name will be put here.</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * @param osize The size of the buffer pointed by output.</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * @return The same value as the pointer output</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> */</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keywordtype">char</span>* <a class="code" href="checksums_8h.html#a0a87db67ee7d98c5663a3ea9beac1cd2" title="Puts into output the full name of the checksum algorithm specified with shortName.">dmlite_checksum_full_name</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* shortName, <span class="keywordtype">char</span>* output,</div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keywordtype">size_t</span> osize);<span class="comment"></span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/**</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * @brief Puts into output the short name of the checksum algorithm</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * specified with longName.</span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * @param shortName The checksum long name (MD5, ADLER32, ...)</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * @param output The short name will be put here.</span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * @param osize The size of the buffer pointed by output.</span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * @return The same value as the pointer output</span></div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> */</span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keywordtype">char</span>* <a class="code" href="checksums_8h.html#af6c009c172b35f080eab5bd0039531ae" title="Puts into output the short name of the checksum algorithm specified with longName.">dmlite_checksum_short_name</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* longName, <span class="keywordtype">char</span>* output,</div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordtype">size_t</span> osize);</div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"></span></div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/**</span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * @brief Generated the MD5 checksum of the given file.</span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * @param fd The file descriptor where to read the data to digest.</span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * @param offset Where to start to digest.</span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * @param size The number of bytes to digest. 0 means the whole file.</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * @param output Where to put the resulting checksum (in hexadecimal)</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * @param outsize The size of the memory area pointed by output.</span></div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * @return 0 on success, error code otherwise.</span></div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> */</span></div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keywordtype">int</span> <a class="code" href="checksums_8h.html#adab5dbf7bb5605ccfad8dc43bb304218" title="Generated the MD5 checksum of the given file.">dmlite_checksum_md5</a>(<a class="code" href="io_8h.html#a4cbc99198fca60683109a3b6b70e4c50">dmlite_fd</a>* fd, off_t offset, off_t size,</div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">char</span>* output, <span class="keywordtype">size_t</span> outsize);</div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"></span></div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">/**</span></div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * @brief Generated the CRC32 checksum of the given file.</span></div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * @param fd The file descriptor where to read the data to digest.</span></div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * @param offset Where to start to digest.</span></div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * @param size The number of bytes to digest. 0 means the whole file.</span></div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * @param output Where to put the resulting checksum (in decimal)</span></div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * @param outsize The size of the memory area pointed by output.</span></div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * @return 0 on success, error code otherwise.</span></div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> */</span></div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="keywordtype">int</span> <a class="code" href="checksums_8h.html#a27f2f50a6107bb2066dd5da56ff9fc24" title="Generated the CRC32 checksum of the given file.">dmlite_checksum_crc32</a>(<a class="code" href="io_8h.html#a4cbc99198fca60683109a3b6b70e4c50">dmlite_fd</a>* fd, off_t offset, off_t size,</div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">char</span>* output, <span class="keywordtype">size_t</span> outsize);</div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span></div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">/**</span></div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * @brief Generated the Adler32 checksum of the given file.</span></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * @param fd The file descriptor where to read the data to digest.</span></div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * @param offset Where to start to digest.</span></div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * @param size The number of bytes to digest. 0 means the whole file.</span></div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * @param output Where to put the resulting checksum (in hexadecimal)</span></div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * @param outsize The size of the memory area pointed by output.</span></div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * @return 0 on success, error code otherwise.</span></div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> */</span></div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="keywordtype">int</span> <a class="code" href="checksums_8h.html#aa1e6b9f70f7995dc783cf99093203caf" title="Generated the Adler32 checksum of the given file.">dmlite_checksum_adler32</a>(<a class="code" href="io_8h.html#a4cbc99198fca60683109a3b6b70e4c50">dmlite_fd</a>* fd, off_t offset, off_t size,</div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">char</span>* output, <span class="keywordtype">size_t</span> outsize);</div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor"></span>}</div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor">#endif </span><span class="comment">/* DMLITE_CHECKSUMS_H */</span><span class="preprocessor"></span></div> </div><!-- fragment --></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>