blob: d34469e51ee49ce07bd51ed215b501afeda2c00c [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 -->
<title>CpuLoadCalculationConstants (OpenJ9 Monitoring and Management Interface Classes)</title>
<meta name="keywords" content="com.ibm.lang.management.CpuLoadCalculationConstants interface">
<meta name="keywords" content="ERROR_VALUE">
<meta name="keywords" content="INSUFFICIENT_PRIVILEGE">
<meta name="keywords" content="UNSUPPORTED_VALUE">
<meta name="keywords" content="INTERNAL_ERROR">
<meta name="keywords" content="MINIMUM_INTERVAL">
<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="CpuLoadCalculationConstants (OpenJ9 Monitoring and Management Interface Classes)";
}
}
catch(err) {
}
//-->
</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="class-use/CpuLoadCalculationConstants.html">Use</a></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 class="aboutLanguage"><strong>OpenJ9 Monitoring and Management Interface Classes</strong></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/ibm/lang/management/AvailableProcessorsNotificationInfo.html" title="class in com.ibm.lang.management"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/ibm/lang/management/ExtendedThreadInfo.html" title="interface in com.ibm.lang.management"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/ibm/lang/management/CpuLoadCalculationConstants.html" target="_top">Frames</a></li>
<li><a href="CpuLoadCalculationConstants.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.ibm.lang.management</div>
<h2 title="Interface CpuLoadCalculationConstants" class="title">Interface CpuLoadCalculationConstants</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">CpuLoadCalculationConstants</span></pre>
<div class="block">Constants used by <a href="../../../../com/ibm/lang/management/OperatingSystemMXBean.html#getProcessCpuLoad--"><code>OperatingSystemMXBean.getProcessCpuLoad()</code></a> and
<a href="../../../../com/ibm/lang/management/OperatingSystemMXBean.html#getSystemCpuLoad--"><code>OperatingSystemMXBean.getSystemCpuLoad()</code></a> methods.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.7.1</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/CpuLoadCalculationConstants.html#ERROR_VALUE">ERROR_VALUE</a></span></code>
<div class="block">Indicates transient error in the port library call.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/CpuLoadCalculationConstants.html#INSUFFICIENT_PRIVILEGE">INSUFFICIENT_PRIVILEGE</a></span></code>
<div class="block">Indicates this function not supported due to insufficient user privilege.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/CpuLoadCalculationConstants.html#INTERNAL_ERROR">INTERNAL_ERROR</a></span></code>
<div class="block">Indicates unexpected internal error.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/CpuLoadCalculationConstants.html#MINIMUM_INTERVAL">MINIMUM_INTERVAL</a></span></code>
<div class="block">The minimum time between successive calls required
to obtain a valid CPU load measurement.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/CpuLoadCalculationConstants.html#UNSUPPORTED_VALUE">UNSUPPORTED_VALUE</a></span></code>
<div class="block">Indicates this function is not supported at all on this platform.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="ERROR_VALUE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ERROR_VALUE</h4>
<pre>static final&nbsp;int ERROR_VALUE</pre>
<div class="block">Indicates transient error in the port library call.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.ibm.lang.management.CpuLoadCalculationConstants.ERROR_VALUE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="INSUFFICIENT_PRIVILEGE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INSUFFICIENT_PRIVILEGE</h4>
<pre>static final&nbsp;int INSUFFICIENT_PRIVILEGE</pre>
<div class="block">Indicates this function not supported due to insufficient user privilege.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.ibm.lang.management.CpuLoadCalculationConstants.INSUFFICIENT_PRIVILEGE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="UNSUPPORTED_VALUE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UNSUPPORTED_VALUE</h4>
<pre>static final&nbsp;int UNSUPPORTED_VALUE</pre>
<div class="block">Indicates this function is not supported at all on this platform.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.ibm.lang.management.CpuLoadCalculationConstants.UNSUPPORTED_VALUE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="INTERNAL_ERROR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INTERNAL_ERROR</h4>
<pre>static final&nbsp;int INTERNAL_ERROR</pre>
<div class="block">Indicates unexpected internal error.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.ibm.lang.management.CpuLoadCalculationConstants.INTERNAL_ERROR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="MINIMUM_INTERVAL">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MINIMUM_INTERVAL</h4>
<pre>static final&nbsp;long MINIMUM_INTERVAL</pre>
<div class="block">The minimum time between successive calls required
to obtain a valid CPU load measurement.
10 ms in nanoseconds.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.ibm.lang.management.CpuLoadCalculationConstants.MINIMUM_INTERVAL">Constant Field Values</a></dd>
</dl>
</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="class-use/CpuLoadCalculationConstants.html">Use</a></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 class="aboutLanguage"><strong>OpenJ9 Monitoring and Management Interface Classes</strong></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/ibm/lang/management/AvailableProcessorsNotificationInfo.html" title="class in com.ibm.lang.management"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/ibm/lang/management/ExtendedThreadInfo.html" title="interface in com.ibm.lang.management"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/ibm/lang/management/CpuLoadCalculationConstants.html" target="_top">Frames</a></li>
<li><a href="CpuLoadCalculationConstants.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse-openj9/openj9/issues" target="_blank">Eclipse OpenJ9 issue.</a><br> Copyright &copy; 2001, 2021, IBM Corp. and others.</small></p>
</body>
</html>