Google Git
Sign in
apache / ignite-website / refs/heads/revert-3-syntax-highlighter-replacement / . / releases / 2.4.0 / cppdoc / classignite_1_1transactions_1_1TransactionMetrics.html
blob: c507d1e8795e92db0b74e5c3f919f5aa81e7875f [file] [log] [blame]
<!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>
<link rel="canonical" href="https://ignite.apache.org/releases/2.4.0/cppdoc/classignite_1_1transactions_1_1TransactionMetrics.html" />
<META NAME="ROBOTS" CONTENT="NOINDEX">
<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.11"/>
<title>&nbsp; Apache Ignite C++: ignite::transactions::TransactionMetrics Class 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-61232409-1', 'auto');
ga('send', 'pageview');
</script></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="projectlogo"><img alt="Logo" src="ignite_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">&nbsp; Apache Ignite C++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<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&#160;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>
<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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceignite.html">ignite</a></li><li class="navelem"><a class="el" href="namespaceignite_1_1transactions.html">transactions</a></li><li class="navelem"><a class="el" href="classignite_1_1transactions_1_1TransactionMetrics.html">TransactionMetrics</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classignite_1_1transactions_1_1TransactionMetrics-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ignite::transactions::TransactionMetrics Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Transaction metrics, shared across all caches.
<a href="classignite_1_1transactions_1_1TransactionMetrics.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="transaction__metrics_8h_source.html">transaction_metrics.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aca2beeb1e127fc069778a8ab8fcaa612"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1TransactionMetrics.html#aca2beeb1e127fc069778a8ab8fcaa612">TransactionMetrics</a> ()</td></tr>
<tr class="memdesc:aca2beeb1e127fc069778a8ab8fcaa612"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <a href="#aca2beeb1e127fc069778a8ab8fcaa612">More...</a><br /></td></tr>
<tr class="separator:aca2beeb1e127fc069778a8ab8fcaa612"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af701ccbed5af0441b27ed36899fde6cd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1TransactionMetrics.html#af701ccbed5af0441b27ed36899fde6cd">TransactionMetrics</a> (const <a class="el" href="classignite_1_1Timestamp.html">Timestamp</a> &amp;commitTime, const <a class="el" href="classignite_1_1Timestamp.html">Timestamp</a> &amp;rollbackTime, int32_t commits, int32_t rollbacks)</td></tr>
<tr class="memdesc:af701ccbed5af0441b27ed36899fde6cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#af701ccbed5af0441b27ed36899fde6cd">More...</a><br /></td></tr>
<tr class="separator:af701ccbed5af0441b27ed36899fde6cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaeba6829ed497b36c2ea4b007e9b43f7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1TransactionMetrics.html#aaeba6829ed497b36c2ea4b007e9b43f7">TransactionMetrics</a> (const <a class="el" href="classignite_1_1transactions_1_1TransactionMetrics.html">TransactionMetrics</a> &amp;other)</td></tr>
<tr class="memdesc:aaeba6829ed497b36c2ea4b007e9b43f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor. <a href="#aaeba6829ed497b36c2ea4b007e9b43f7">More...</a><br /></td></tr>
<tr class="separator:aaeba6829ed497b36c2ea4b007e9b43f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a408e153d34e91fd95013d406d82680d0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1transactions_1_1TransactionMetrics.html">TransactionMetrics</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1TransactionMetrics.html#a408e153d34e91fd95013d406d82680d0">operator=</a> (const <a class="el" href="classignite_1_1transactions_1_1TransactionMetrics.html">TransactionMetrics</a> &amp;other)</td></tr>
<tr class="memdesc:a408e153d34e91fd95013d406d82680d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator. <a href="#a408e153d34e91fd95013d406d82680d0">More...</a><br /></td></tr>
<tr class="separator:a408e153d34e91fd95013d406d82680d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68657c708c617e8d4c161c0b9639f7a9"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classignite_1_1Timestamp.html">Timestamp</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1TransactionMetrics.html#a68657c708c617e8d4c161c0b9639f7a9">GetCommitTime</a> () const </td></tr>
<tr class="memdesc:a68657c708c617e8d4c161c0b9639f7a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get commit time. <a href="#a68657c708c617e8d4c161c0b9639f7a9">More...</a><br /></td></tr>
<tr class="separator:a68657c708c617e8d4c161c0b9639f7a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af491f4b4e25a91f6ba5c288213625a72"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classignite_1_1Timestamp.html">Timestamp</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1TransactionMetrics.html#af491f4b4e25a91f6ba5c288213625a72">GetRollbackTime</a> () const </td></tr>
<tr class="memdesc:af491f4b4e25a91f6ba5c288213625a72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get rollback time. <a href="#af491f4b4e25a91f6ba5c288213625a72">More...</a><br /></td></tr>
<tr class="separator:af491f4b4e25a91f6ba5c288213625a72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae91ebce710cf921fffae5c6960173374"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1TransactionMetrics.html#ae91ebce710cf921fffae5c6960173374">GetCommits</a> () const </td></tr>
<tr class="memdesc:ae91ebce710cf921fffae5c6960173374"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the total number of transaction commits. <a href="#ae91ebce710cf921fffae5c6960173374">More...</a><br /></td></tr>
<tr class="separator:ae91ebce710cf921fffae5c6960173374"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a2d2859123818db0afc957519177717"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1TransactionMetrics.html#a5a2d2859123818db0afc957519177717">GetRollbacks</a> () const </td></tr>
<tr class="memdesc:a5a2d2859123818db0afc957519177717"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the total number of transaction rollbacks. <a href="#a5a2d2859123818db0afc957519177717">More...</a><br /></td></tr>
<tr class="separator:a5a2d2859123818db0afc957519177717"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a8670808f009ae3267c06677846bd2b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1TransactionMetrics.html#a5a8670808f009ae3267c06677846bd2b">IsValid</a> () const </td></tr>
<tr class="memdesc:a5a8670808f009ae3267c06677846bd2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check wheather the instance is valid. <a href="#a5a8670808f009ae3267c06677846bd2b">More...</a><br /></td></tr>
<tr class="separator:a5a8670808f009ae3267c06677846bd2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Transaction metrics, shared across all caches. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aca2beeb1e127fc069778a8ab8fcaa612"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ignite::transactions::TransactionMetrics::TransactionMetrics </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor. </p>
<p>Constructed instance is not valid. </p>
</div>
</div>
<a class="anchor" id="af701ccbed5af0441b27ed36899fde6cd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ignite::transactions::TransactionMetrics::TransactionMetrics </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classignite_1_1Timestamp.html">Timestamp</a> &amp;&#160;</td>
<td class="paramname"><em>commitTime</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classignite_1_1Timestamp.html">Timestamp</a> &amp;&#160;</td>
<td class="paramname"><em>rollbackTime</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>commits</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>rollbacks</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">commitTime</td><td>The last time transaction was committed. </td></tr>
<tr><td class="paramname">rollbackTime</td><td>The last time transaction was rolled back. </td></tr>
<tr><td class="paramname">commits</td><td>The total number of transaction commits. </td></tr>
<tr><td class="paramname">rollbacks</td><td>The total number of transaction rollbacks. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aaeba6829ed497b36c2ea4b007e9b43f7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ignite::transactions::TransactionMetrics::TransactionMetrics </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classignite_1_1transactions_1_1TransactionMetrics.html">TransactionMetrics</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>Another instance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ae91ebce710cf921fffae5c6960173374"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int32_t ignite::transactions::TransactionMetrics::GetCommits </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the total number of transaction commits. </p>
<dl class="section return"><dt>Returns</dt><dd>The total number of transaction commits. </dd></dl>
</div>
</div>
<a class="anchor" id="a68657c708c617e8d4c161c0b9639f7a9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classignite_1_1Timestamp.html">Timestamp</a>&amp; ignite::transactions::TransactionMetrics::GetCommitTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get commit time. </p>
<dl class="section return"><dt>Returns</dt><dd>The last time transaction was committed. </dd></dl>
</div>
</div>
<a class="anchor" id="a5a2d2859123818db0afc957519177717"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int32_t ignite::transactions::TransactionMetrics::GetRollbacks </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the total number of transaction rollbacks. </p>
<dl class="section return"><dt>Returns</dt><dd>The total number of transaction rollbacks. </dd></dl>
</div>
</div>
<a class="anchor" id="af491f4b4e25a91f6ba5c288213625a72"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classignite_1_1Timestamp.html">Timestamp</a>&amp; ignite::transactions::TransactionMetrics::GetRollbackTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get rollback time. </p>
<dl class="section return"><dt>Returns</dt><dd>The last time transaction was rolled back. </dd></dl>
</div>
</div>
<a class="anchor" id="a5a8670808f009ae3267c06677846bd2b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ignite::transactions::TransactionMetrics::IsValid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check wheather the instance is valid. </p>
<p>Invalid instance can be returned if some of the previous operations have resulted in a failure. For example invalid instance can be returned by not-throwing version of method in case of error. Invalid instances also often can be created using default constructor.</p>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the instance contains valid data. </dd></dl>
</div>
</div>
<a class="anchor" id="a408e153d34e91fd95013d406d82680d0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classignite_1_1transactions_1_1TransactionMetrics.html">TransactionMetrics</a>&amp; ignite::transactions::TransactionMetrics::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classignite_1_1transactions_1_1TransactionMetrics.html">TransactionMetrics</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Assignment operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>Another instance. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>*this</code>. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="transaction__metrics_8h_source.html">transaction_metrics.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Mar 5 2018 10:33:58 for &nbsp; Apache Ignite C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>