blob: f6f223ee6fb18c58ca722896e154a98b984991ef [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_121) on Tue Apr 25 03:06:36 SST 2017 -->
<title>Metrics.Timer</title>
<meta name="date" content="2017-04-25">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Metrics.Timer";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/gearpump/metrics/Metrics.ReportMetrics$.html" title="class in org.apache.gearpump.metrics"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/gearpump/metrics/Metrics.Timer$.html" title="class in org.apache.gearpump.metrics"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/gearpump/metrics/Metrics.Timer.html" target="_top">Frames</a></li>
<li><a href="Metrics.Timer.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.gearpump.metrics</div>
<h2 title="Class Metrics.Timer" class="title">Class Metrics.Timer</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.gearpump.metrics.Metrics.Timer</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, <a href="../../../../org/apache/gearpump/metrics/Metrics.MetricType.html" title="interface in org.apache.gearpump.metrics">Metrics.MetricType</a>, scala.Equals, scala.Product</dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../org/apache/gearpump/metrics/Metrics.html" title="class in org.apache.gearpump.metrics">Metrics</a></dd>
</dl>
<hr>
<br>
<pre>public static class <span class="typeNameLabel">Metrics.Timer</span>
extends java.lang.Object
implements <a href="../../../../org/apache/gearpump/metrics/Metrics.MetricType.html" title="interface in org.apache.gearpump.metrics">Metrics.MetricType</a>, scala.Product, scala.Serializable</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../serialized-form.html#org.apache.gearpump.metrics.Metrics.Timer">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/metrics/Metrics.Timer.html#Timer-java.lang.String-long-double-double-double-double-double-double-double-double-double-double-double-double-double-double-java.lang.String-java.lang.String-">Timer</a></span>(java.lang.String&nbsp;name,
long&nbsp;count,
double&nbsp;min,
double&nbsp;max,
double&nbsp;mean,
double&nbsp;stddev,
double&nbsp;median,
double&nbsp;p75,
double&nbsp;p95,
double&nbsp;p98,
double&nbsp;p99,
double&nbsp;p999,
double&nbsp;meanRate,
double&nbsp;m1,
double&nbsp;m5,
double&nbsp;m15,
java.lang.String&nbsp;rateUnit,
java.lang.String&nbsp;durationUnit)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/metrics/Metrics.Timer.html#count--">count</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/metrics/Metrics.Timer.html#durationUnit--">durationUnit</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/metrics/Metrics.Timer.html#m1--">m1</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/metrics/Metrics.Timer.html#m15--">m15</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/metrics/Metrics.Timer.html#m5--">m5</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/metrics/Metrics.Timer.html#max--">max</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/metrics/Metrics.Timer.html#mean--">mean</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/metrics/Metrics.Timer.html#meanRate--">meanRate</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/metrics/Metrics.Timer.html#median--">median</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/metrics/Metrics.Timer.html#min--">min</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/metrics/Metrics.Timer.html#name--">name</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/metrics/Metrics.Timer.html#p75--">p75</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/metrics/Metrics.Timer.html#p95--">p95</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/metrics/Metrics.Timer.html#p98--">p98</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/metrics/Metrics.Timer.html#p99--">p99</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/metrics/Metrics.Timer.html#p999--">p999</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/metrics/Metrics.Timer.html#rateUnit--">rateUnit</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/gearpump/metrics/Metrics.Timer.html#stddev--">stddev</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.scala.Product">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;scala.Product</h3>
<code>productArity, productElement, productIterator, productPrefix</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.scala.Equals">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;scala.Equals</h3>
<code>canEqual, equals</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Timer-java.lang.String-long-double-double-double-double-double-double-double-double-double-double-double-double-double-double-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Timer</h4>
<pre>public&nbsp;Timer(java.lang.String&nbsp;name,
long&nbsp;count,
double&nbsp;min,
double&nbsp;max,
double&nbsp;mean,
double&nbsp;stddev,
double&nbsp;median,
double&nbsp;p75,
double&nbsp;p95,
double&nbsp;p98,
double&nbsp;p99,
double&nbsp;p999,
double&nbsp;meanRate,
double&nbsp;m1,
double&nbsp;m5,
double&nbsp;m15,
java.lang.String&nbsp;rateUnit,
java.lang.String&nbsp;durationUnit)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="name--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre>public&nbsp;java.lang.String&nbsp;name()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/gearpump/metrics/Metrics.MetricType.html#name--">name</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/gearpump/metrics/Metrics.MetricType.html" title="interface in org.apache.gearpump.metrics">Metrics.MetricType</a></code></dd>
</dl>
</li>
</ul>
<a name="count--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>count</h4>
<pre>public&nbsp;long&nbsp;count()</pre>
</li>
</ul>
<a name="min--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>min</h4>
<pre>public&nbsp;double&nbsp;min()</pre>
</li>
</ul>
<a name="max--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>max</h4>
<pre>public&nbsp;double&nbsp;max()</pre>
</li>
</ul>
<a name="mean--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mean</h4>
<pre>public&nbsp;double&nbsp;mean()</pre>
</li>
</ul>
<a name="stddev--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stddev</h4>
<pre>public&nbsp;double&nbsp;stddev()</pre>
</li>
</ul>
<a name="median--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>median</h4>
<pre>public&nbsp;double&nbsp;median()</pre>
</li>
</ul>
<a name="p75--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>p75</h4>
<pre>public&nbsp;double&nbsp;p75()</pre>
</li>
</ul>
<a name="p95--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>p95</h4>
<pre>public&nbsp;double&nbsp;p95()</pre>
</li>
</ul>
<a name="p98--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>p98</h4>
<pre>public&nbsp;double&nbsp;p98()</pre>
</li>
</ul>
<a name="p99--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>p99</h4>
<pre>public&nbsp;double&nbsp;p99()</pre>
</li>
</ul>
<a name="p999--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>p999</h4>
<pre>public&nbsp;double&nbsp;p999()</pre>
</li>
</ul>
<a name="meanRate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>meanRate</h4>
<pre>public&nbsp;double&nbsp;meanRate()</pre>
</li>
</ul>
<a name="m1--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>m1</h4>
<pre>public&nbsp;double&nbsp;m1()</pre>
</li>
</ul>
<a name="m5--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>m5</h4>
<pre>public&nbsp;double&nbsp;m5()</pre>
</li>
</ul>
<a name="m15--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>m15</h4>
<pre>public&nbsp;double&nbsp;m15()</pre>
</li>
</ul>
<a name="rateUnit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rateUnit</h4>
<pre>public&nbsp;java.lang.String&nbsp;rateUnit()</pre>
</li>
</ul>
<a name="durationUnit--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>durationUnit</h4>
<pre>public&nbsp;java.lang.String&nbsp;durationUnit()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/gearpump/metrics/Metrics.ReportMetrics$.html" title="class in org.apache.gearpump.metrics"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/gearpump/metrics/Metrics.Timer$.html" title="class in org.apache.gearpump.metrics"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/gearpump/metrics/Metrics.Timer.html" target="_top">Frames</a></li>
<li><a href="Metrics.Timer.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>