<!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.6"/>
<title>createrepo_c library: API for checksum calculation.</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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">createrepo_c library
 <span id="projectnumber">0.7.4</span>
</div>
<div id="projectbrief">C library for metadata manipulation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__checksum.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">API for checksum calculation.</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gaeae983db1244814c23d0b6f190b85669"><td class="memItemLeft" align="right" valign="top">typedef struct _cr_ChecksumCtx </td><td class="memItemRight" valign="bottom"><a class="el" href="group__checksum.html#gaeae983db1244814c23d0b6f190b85669">cr_ChecksumCtx</a></td></tr>
<tr class="separator:gaeae983db1244814c23d0b6f190b85669"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga36a5d391d81917afca751eb71514f2cf"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__checksum.html#ga36a5d391d81917afca751eb71514f2cf">cr_ChecksumType</a> { <br/>
  <a class="el" href="group__checksum.html#gga36a5d391d81917afca751eb71514f2cfac9430fd9003166c894191f691297dcc4">CR_CHECKSUM_UNKNOWN</a>,
<a class="el" href="group__checksum.html#gga36a5d391d81917afca751eb71514f2cfabbd8d21f07bcd268d5459423099e63d6">CR_CHECKSUM_MD5</a>,
<a class="el" href="group__checksum.html#gga36a5d391d81917afca751eb71514f2cfafa26e0c43f14f2e8f9eb9ec56c96a249">CR_CHECKSUM_SHA</a>,
<a class="el" href="group__checksum.html#gga36a5d391d81917afca751eb71514f2cfad9fd77ed9119d4d6e34f3e5823052d0e">CR_CHECKSUM_SHA1</a>,
<br/>
  <a class="el" href="group__checksum.html#gga36a5d391d81917afca751eb71514f2cfa47b1afb83f368037d3e752d5f3f3bd32">CR_CHECKSUM_SHA224</a>,
<a class="el" href="group__checksum.html#gga36a5d391d81917afca751eb71514f2cfaf295572a343c09092a0f1d18dc954b8f">CR_CHECKSUM_SHA256</a>,
<a class="el" href="group__checksum.html#gga36a5d391d81917afca751eb71514f2cfa878bf63cd9c0586d04a4beb7d18f830b">CR_CHECKSUM_SHA384</a>,
<a class="el" href="group__checksum.html#gga36a5d391d81917afca751eb71514f2cfaa29895fbb702cb7feb9b4333f02e2e5d">CR_CHECKSUM_SHA512</a>,
<br/>
  <a class="el" href="group__checksum.html#gga36a5d391d81917afca751eb71514f2cfa4d969bcb29f49f5096ad45140fff25ae">CR_CHECKSUM_SENTINEL</a>
<br/>
}</td></tr>
<tr class="separator:ga36a5d391d81917afca751eb71514f2cf"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga120110e97722b2e8612b60bbc1b2e3a8"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__checksum.html#ga120110e97722b2e8612b60bbc1b2e3a8">cr_checksum_name_str</a> (<a class="el" href="group__checksum.html#ga36a5d391d81917afca751eb71514f2cf">cr_ChecksumType</a> type)</td></tr>
<tr class="separator:ga120110e97722b2e8612b60bbc1b2e3a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6773e60dff3bc59b2da0fef0c981bdbb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__checksum.html#ga36a5d391d81917afca751eb71514f2cf">cr_ChecksumType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__checksum.html#ga6773e60dff3bc59b2da0fef0c981bdbb">cr_checksum_type</a> (const char *name)</td></tr>
<tr class="separator:ga6773e60dff3bc59b2da0fef0c981bdbb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga799edee00f25e72a6508877c460bc930"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__checksum.html#ga799edee00f25e72a6508877c460bc930">cr_checksum_file</a> (const char *filename, <a class="el" href="group__checksum.html#ga36a5d391d81917afca751eb71514f2cf">cr_ChecksumType</a> type, GError **err)</td></tr>
<tr class="separator:ga799edee00f25e72a6508877c460bc930"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf41784870de1316faceed43c78229b0c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__checksum.html#gaeae983db1244814c23d0b6f190b85669">cr_ChecksumCtx</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__checksum.html#gaf41784870de1316faceed43c78229b0c">cr_checksum_new</a> (<a class="el" href="group__checksum.html#ga36a5d391d81917afca751eb71514f2cf">cr_ChecksumType</a> type, GError **err)</td></tr>
<tr class="separator:gaf41784870de1316faceed43c78229b0c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0163eea824c8f88675a8bb99a0536883"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__checksum.html#ga0163eea824c8f88675a8bb99a0536883">cr_checksum_update</a> (<a class="el" href="group__checksum.html#gaeae983db1244814c23d0b6f190b85669">cr_ChecksumCtx</a> *ctx, const void *buf, size_t len, GError **err)</td></tr>
<tr class="separator:ga0163eea824c8f88675a8bb99a0536883"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0a5c263dbc1e024458c8be26927a2540"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__checksum.html#ga0a5c263dbc1e024458c8be26927a2540">cr_checksum_final</a> (<a class="el" href="group__checksum.html#gaeae983db1244814c23d0b6f190b85669">cr_ChecksumCtx</a> *ctx, GError **err)</td></tr>
<tr class="separator:ga0a5c263dbc1e024458c8be26927a2540"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gaeae983db1244814c23d0b6f190b85669"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct _cr_ChecksumCtx <a class="el" href="group__checksum.html#gaeae983db1244814c23d0b6f190b85669">cr_ChecksumCtx</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checksum context. </p>
<p>Definition at line <a class="el" href="checksum_8h_source.html#l00036">36</a> of file <a class="el" href="checksum_8h_source.html">checksum.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga36a5d391d81917afca751eb71514f2cf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__checksum.html#ga36a5d391d81917afca751eb71514f2cf">cr_ChecksumType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enum of supported checksum types. Note: SHA is just a "nickname" for the SHA1. This is for the compatibility with original createrepo. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga36a5d391d81917afca751eb71514f2cfac9430fd9003166c894191f691297dcc4"></a>CR_CHECKSUM_UNKNOWN</em> </td><td class="fielddoc">
<p>Unknown checksum </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga36a5d391d81917afca751eb71514f2cfabbd8d21f07bcd268d5459423099e63d6"></a>CR_CHECKSUM_MD5</em> </td><td class="fielddoc">
<p>MD5 checksum </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga36a5d391d81917afca751eb71514f2cfafa26e0c43f14f2e8f9eb9ec56c96a249"></a>CR_CHECKSUM_SHA</em> </td><td class="fielddoc">
<p>SHA checksum </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga36a5d391d81917afca751eb71514f2cfad9fd77ed9119d4d6e34f3e5823052d0e"></a>CR_CHECKSUM_SHA1</em> </td><td class="fielddoc">
<p>SHA1 checksum </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga36a5d391d81917afca751eb71514f2cfa47b1afb83f368037d3e752d5f3f3bd32"></a>CR_CHECKSUM_SHA224</em> </td><td class="fielddoc">
<p>SHA224 checksum </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga36a5d391d81917afca751eb71514f2cfaf295572a343c09092a0f1d18dc954b8f"></a>CR_CHECKSUM_SHA256</em> </td><td class="fielddoc">
<p>SHA256 checksum </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga36a5d391d81917afca751eb71514f2cfa878bf63cd9c0586d04a4beb7d18f830b"></a>CR_CHECKSUM_SHA384</em> </td><td class="fielddoc">
<p>SHA384 checksum </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga36a5d391d81917afca751eb71514f2cfaa29895fbb702cb7feb9b4333f02e2e5d"></a>CR_CHECKSUM_SHA512</em> </td><td class="fielddoc">
<p>SHA512 checksum </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga36a5d391d81917afca751eb71514f2cfa4d969bcb29f49f5096ad45140fff25ae"></a>CR_CHECKSUM_SENTINEL</em> </td><td class="fielddoc">
<p>sentinel of the list </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="checksum_8h_source.html#l00043">43</a> of file <a class="el" href="checksum_8h_source.html">checksum.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga799edee00f25e72a6508877c460bc930"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* cr_checksum_file </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__checksum.html#ga36a5d391d81917afca751eb71514f2cf">cr_ChecksumType</a> </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GError ** </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Compute file checksum. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>filename </td></tr>
<tr><td class="paramname">type</td><td>type of checksum </td></tr>
<tr><td class="paramname">err</td><td>GError ** </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>malloced null terminated string with checksum or NULL on error </dd></dl>
</div>
</div>
<a class="anchor" id="ga0a5c263dbc1e024458c8be26927a2540"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* cr_checksum_final </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__checksum.html#gaeae983db1244814c23d0b6f190b85669">cr_ChecksumCtx</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GError ** </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Finalize checksum calculation, return checksum string and frees all checksum context resources. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>Checksum context. </td></tr>
<tr><td class="paramname">err</td><td>GError ** </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Checksum string or NULL on error. </dd></dl>
</div>
</div>
<a class="anchor" id="ga120110e97722b2e8612b60bbc1b2e3a8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* cr_checksum_name_str </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__checksum.html#ga36a5d391d81917afca751eb71514f2cf">cr_ChecksumType</a> </td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return checksum name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>checksum type </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>constant null terminated string with checksum name or NULL on error </dd></dl>
</div>
</div>
<a class="anchor" id="gaf41784870de1316faceed43c78229b0c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__checksum.html#gaeae983db1244814c23d0b6f190b85669">cr_ChecksumCtx</a>* cr_checksum_new </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__checksum.html#ga36a5d391d81917afca751eb71514f2cf">cr_ChecksumType</a> </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GError ** </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create new checksum context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>Checksum algorithm of the new checksum context. </td></tr>
<tr><td class="paramname">err</td><td>GError ** </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>cr_ChecksumCtx or NULL on error </dd></dl>
</div>
</div>
<a class="anchor" id="ga6773e60dff3bc59b2da0fef0c981bdbb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__checksum.html#ga36a5d391d81917afca751eb71514f2cf">cr_ChecksumType</a> cr_checksum_type </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return checksum type. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>checksum name </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>checksum type </dd></dl>
</div>
</div>
<a class="anchor" id="ga0163eea824c8f88675a8bb99a0536883"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int cr_checksum_update </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__checksum.html#gaeae983db1244814c23d0b6f190b85669">cr_ChecksumCtx</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GError ** </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Feeds data into the checksum. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>Checksum context. </td></tr>
<tr><td class="paramname">buf</td><td>Pointer to the data. </td></tr>
<tr><td class="paramname">len</td><td>Length of the data. </td></tr>
<tr><td class="paramname">err</td><td>GError ** </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>cr_Error code. </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Tue Nov 11 2014 15:15:01 for createrepo_c library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
</ul>
</div>
</body>
</html>
