<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rpm: Statistics API.</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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rpm
 <span id="projectnumber">4.14.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Statistics API.</div> </div>
</div><!--header-->
<div class="contents">
<p>Statistics API.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structrpmsw__s.html">rpmsw_s</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structrpmop__s.html">rpmop_s</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Cumulative statistics for an operation. <a href="structrpmop__s.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga17f1fdbc48f3de7d0498dc8a14d8fad3"><td class="memItemLeft" align="right" valign="top">typedef unsigned long int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rpmsw.html#ga17f1fdbc48f3de7d0498dc8a14d8fad3">rpmtime_t</a></td></tr>
<tr class="separator:ga17f1fdbc48f3de7d0498dc8a14d8fad3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad7c276bda649c14108c422c82bfd3433"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structrpmsw__s.html">rpmsw_s</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rpmsw.html#gad7c276bda649c14108c422c82bfd3433">rpmsw</a></td></tr>
<tr class="separator:gad7c276bda649c14108c422c82bfd3433"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga94f0970d0256edb3a66fbf260bbfec6f"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structrpmop__s.html">rpmop_s</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rpmsw.html#ga94f0970d0256edb3a66fbf260bbfec6f">rpmop</a></td></tr>
<tr class="separator:ga94f0970d0256edb3a66fbf260bbfec6f"><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:gad3978708dadb86ed1e480cfa37bedfbc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__rpmsw.html#gad7c276bda649c14108c422c82bfd3433">rpmsw</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rpmsw.html#gad3978708dadb86ed1e480cfa37bedfbc">rpmswNow</a> (<a class="el" href="group__rpmsw.html#gad7c276bda649c14108c422c82bfd3433">rpmsw</a> sw)</td></tr>
<tr class="memdesc:gad3978708dadb86ed1e480cfa37bedfbc"><td class="mdescLeft"> </td><td class="mdescRight">Return benchmark time stamp. <a href="#gad3978708dadb86ed1e480cfa37bedfbc">More...</a><br /></td></tr>
<tr class="separator:gad3978708dadb86ed1e480cfa37bedfbc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga640c70b2a8e24884797ed574f06cd11e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__rpmsw.html#ga17f1fdbc48f3de7d0498dc8a14d8fad3">rpmtime_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rpmsw.html#ga640c70b2a8e24884797ed574f06cd11e">rpmswDiff</a> (<a class="el" href="group__rpmsw.html#gad7c276bda649c14108c422c82bfd3433">rpmsw</a> end, <a class="el" href="group__rpmsw.html#gad7c276bda649c14108c422c82bfd3433">rpmsw</a> begin)</td></tr>
<tr class="memdesc:ga640c70b2a8e24884797ed574f06cd11e"><td class="mdescLeft"> </td><td class="mdescRight">Return benchmark time stamp difference. <a href="#ga640c70b2a8e24884797ed574f06cd11e">More...</a><br /></td></tr>
<tr class="separator:ga640c70b2a8e24884797ed574f06cd11e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7736ea08d529c45512d8cd17c802baa1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__rpmsw.html#ga17f1fdbc48f3de7d0498dc8a14d8fad3">rpmtime_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rpmsw.html#ga7736ea08d529c45512d8cd17c802baa1">rpmswInit</a> (void)</td></tr>
<tr class="memdesc:ga7736ea08d529c45512d8cd17c802baa1"><td class="mdescLeft"> </td><td class="mdescRight">Return benchmark time stamp overhead. <a href="#ga7736ea08d529c45512d8cd17c802baa1">More...</a><br /></td></tr>
<tr class="separator:ga7736ea08d529c45512d8cd17c802baa1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7f69caae88f9572093fc8b0adf8ecf65"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rpmsw.html#ga7f69caae88f9572093fc8b0adf8ecf65">rpmswEnter</a> (<a class="el" href="group__rpmsw.html#ga94f0970d0256edb3a66fbf260bbfec6f">rpmop</a> op, ssize_t rc)</td></tr>
<tr class="memdesc:ga7f69caae88f9572093fc8b0adf8ecf65"><td class="mdescLeft"> </td><td class="mdescRight">Enter timed operation. <a href="#ga7f69caae88f9572093fc8b0adf8ecf65">More...</a><br /></td></tr>
<tr class="separator:ga7f69caae88f9572093fc8b0adf8ecf65"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga59c7d4152875cee4e893b5a27ce6b02a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__rpmsw.html#ga17f1fdbc48f3de7d0498dc8a14d8fad3">rpmtime_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rpmsw.html#ga59c7d4152875cee4e893b5a27ce6b02a">rpmswExit</a> (<a class="el" href="group__rpmsw.html#ga94f0970d0256edb3a66fbf260bbfec6f">rpmop</a> op, ssize_t rc)</td></tr>
<tr class="memdesc:ga59c7d4152875cee4e893b5a27ce6b02a"><td class="mdescLeft"> </td><td class="mdescRight">Exit timed operation. <a href="#ga59c7d4152875cee4e893b5a27ce6b02a">More...</a><br /></td></tr>
<tr class="separator:ga59c7d4152875cee4e893b5a27ce6b02a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga46822386355eebdf0030ed862eae9b35"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__rpmsw.html#ga17f1fdbc48f3de7d0498dc8a14d8fad3">rpmtime_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rpmsw.html#ga46822386355eebdf0030ed862eae9b35">rpmswAdd</a> (<a class="el" href="group__rpmsw.html#ga94f0970d0256edb3a66fbf260bbfec6f">rpmop</a> to, <a class="el" href="group__rpmsw.html#ga94f0970d0256edb3a66fbf260bbfec6f">rpmop</a> from)</td></tr>
<tr class="memdesc:ga46822386355eebdf0030ed862eae9b35"><td class="mdescLeft"> </td><td class="mdescRight">Sum statistic counters. <a href="#ga46822386355eebdf0030ed862eae9b35">More...</a><br /></td></tr>
<tr class="separator:ga46822386355eebdf0030ed862eae9b35"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga85fb8eaf390eb601c4c3127265639670"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__rpmsw.html#ga17f1fdbc48f3de7d0498dc8a14d8fad3">rpmtime_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rpmsw.html#ga85fb8eaf390eb601c4c3127265639670">rpmswSub</a> (<a class="el" href="group__rpmsw.html#ga94f0970d0256edb3a66fbf260bbfec6f">rpmop</a> to, <a class="el" href="group__rpmsw.html#ga94f0970d0256edb3a66fbf260bbfec6f">rpmop</a> from)</td></tr>
<tr class="memdesc:ga85fb8eaf390eb601c4c3127265639670"><td class="mdescLeft"> </td><td class="mdescRight">Subtract statistic counters. <a href="#ga85fb8eaf390eb601c4c3127265639670">More...</a><br /></td></tr>
<tr class="separator:ga85fb8eaf390eb601c4c3127265639670"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Statistics API. </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga94f0970d0256edb3a66fbf260bbfec6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga94f0970d0256edb3a66fbf260bbfec6f">◆ </a></span>rpmop</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structrpmop__s.html">rpmop_s</a>* <a class="el" href="group__rpmsw.html#ga94f0970d0256edb3a66fbf260bbfec6f">rpmop</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="rpmsw_8h_source.html#l00027">27</a> of file <a class="el" href="rpmsw_8h_source.html">rpmsw.h</a>.</p>
</div>
</div>
<a id="gad7c276bda649c14108c422c82bfd3433"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad7c276bda649c14108c422c82bfd3433">◆ </a></span>rpmsw</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structrpmsw__s.html">rpmsw_s</a>* <a class="el" href="group__rpmsw.html#gad7c276bda649c14108c422c82bfd3433">rpmsw</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="rpmsw_8h_source.html#l00023">23</a> of file <a class="el" href="rpmsw_8h_source.html">rpmsw.h</a>.</p>
</div>
</div>
<a id="ga17f1fdbc48f3de7d0498dc8a14d8fad3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga17f1fdbc48f3de7d0498dc8a14d8fad3">◆ </a></span>rpmtime_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef unsigned long int <a class="el" href="group__rpmsw.html#ga17f1fdbc48f3de7d0498dc8a14d8fad3">rpmtime_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="rpmsw_8h_source.html#l00019">19</a> of file <a class="el" href="rpmsw_8h_source.html">rpmsw.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga46822386355eebdf0030ed862eae9b35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga46822386355eebdf0030ed862eae9b35">◆ </a></span>rpmswAdd()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__rpmsw.html#ga17f1fdbc48f3de7d0498dc8a14d8fad3">rpmtime_t</a> rpmswAdd </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__rpmsw.html#ga94f0970d0256edb3a66fbf260bbfec6f">rpmop</a> </td>
<td class="paramname"><em>to</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__rpmsw.html#ga94f0970d0256edb3a66fbf260bbfec6f">rpmop</a> </td>
<td class="paramname"><em>from</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sum statistic counters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">to</td><td>result statistics </td></tr>
<tr><td class="paramname">from</td><td>operation statistics </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>cumulative usecs for operation </dd></dl>
</div>
</div>
<a id="ga640c70b2a8e24884797ed574f06cd11e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga640c70b2a8e24884797ed574f06cd11e">◆ </a></span>rpmswDiff()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__rpmsw.html#ga17f1fdbc48f3de7d0498dc8a14d8fad3">rpmtime_t</a> rpmswDiff </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__rpmsw.html#gad7c276bda649c14108c422c82bfd3433">rpmsw</a> </td>
<td class="paramname"><em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__rpmsw.html#gad7c276bda649c14108c422c82bfd3433">rpmsw</a> </td>
<td class="paramname"><em>begin</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return benchmark time stamp difference. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">*end</td><td>end time stamp </td></tr>
<tr><td class="paramname">*begin</td><td>begin time stamp </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>difference in micro-seconds </dd></dl>
</div>
</div>
<a id="ga7f69caae88f9572093fc8b0adf8ecf65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7f69caae88f9572093fc8b0adf8ecf65">◆ </a></span>rpmswEnter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rpmswEnter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__rpmsw.html#ga94f0970d0256edb3a66fbf260bbfec6f">rpmop</a> </td>
<td class="paramname"><em>op</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ssize_t </td>
<td class="paramname"><em>rc</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enter timed operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">op</td><td>operation statistics </td></tr>
<tr><td class="paramname">rc</td><td>-1 clears usec counter </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 always </dd></dl>
</div>
</div>
<a id="ga59c7d4152875cee4e893b5a27ce6b02a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga59c7d4152875cee4e893b5a27ce6b02a">◆ </a></span>rpmswExit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__rpmsw.html#ga17f1fdbc48f3de7d0498dc8a14d8fad3">rpmtime_t</a> rpmswExit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__rpmsw.html#ga94f0970d0256edb3a66fbf260bbfec6f">rpmop</a> </td>
<td class="paramname"><em>op</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ssize_t </td>
<td class="paramname"><em>rc</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Exit timed operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">op</td><td>operation statistics </td></tr>
<tr><td class="paramname">rc</td><td>per-operation data (e.g. bytes transferred) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>cumulative usecs for operation </dd></dl>
</div>
</div>
<a id="ga7736ea08d529c45512d8cd17c802baa1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7736ea08d529c45512d8cd17c802baa1">◆ </a></span>rpmswInit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__rpmsw.html#ga17f1fdbc48f3de7d0498dc8a14d8fad3">rpmtime_t</a> rpmswInit </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return benchmark time stamp overhead. </p>
<dl class="section return"><dt>Returns</dt><dd>overhead in micro-seconds </dd></dl>
</div>
</div>
<a id="gad3978708dadb86ed1e480cfa37bedfbc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad3978708dadb86ed1e480cfa37bedfbc">◆ </a></span>rpmswNow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__rpmsw.html#gad7c276bda649c14108c422c82bfd3433">rpmsw</a> rpmswNow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__rpmsw.html#gad7c276bda649c14108c422c82bfd3433">rpmsw</a> </td>
<td class="paramname"><em>sw</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return benchmark time stamp. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">*sw</td><td>time stamp </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success </dd></dl>
</div>
</div>
<a id="ga85fb8eaf390eb601c4c3127265639670"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga85fb8eaf390eb601c4c3127265639670">◆ </a></span>rpmswSub()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__rpmsw.html#ga17f1fdbc48f3de7d0498dc8a14d8fad3">rpmtime_t</a> rpmswSub </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__rpmsw.html#ga94f0970d0256edb3a66fbf260bbfec6f">rpmop</a> </td>
<td class="paramname"><em>to</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__rpmsw.html#ga94f0970d0256edb3a66fbf260bbfec6f">rpmop</a> </td>
<td class="paramname"><em>from</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Subtract statistic counters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">to</td><td>result statistics </td></tr>
<tr><td class="paramname">from</td><td>operation statistics </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>cumulative usecs for operation </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>