blob: d4c3cce366732856663f99223300d94ed5dd5c63 [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_262-internal) on Thu Jun 04 16:40:07 GMT 2020 -->
<title>ProcessorMXBean (OpenJ9 Monitoring and Management Interface Classes)</title>
<meta name="date" content="2020-06-04">
<meta name="keywords" content="com.ibm.lang.management.ProcessorMXBean interface">
<meta name="keywords" content="getNumberPhysicalCPUs()">
<meta name="keywords" content="getNumberOnlineCPUs()">
<meta name="keywords" content="getNumberBoundCPUs()">
<meta name="keywords" content="getNumberTargetCPUs()">
<meta name="keywords" content="setNumberActiveCPUs()">
<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="ProcessorMXBean (OpenJ9 Monitoring and Management Interface Classes)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="class-use/ProcessorMXBean.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/ProcessingCapacityNotificationInfo.html" title="class in com.ibm.lang.management"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/ibm/lang/management/ProcessorUsage.html" title="class 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/ProcessorMXBean.html" target="_top">Frames</a></li>
<li><a href="ProcessorMXBean.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>Constr&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>Constr&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">com.ibm.lang.management</div>
<h2 title="Interface ProcessorMXBean" class="title">Interface ProcessorMXBean</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/PlatformManagedObject.html?is-external=true" target="_blank" title="class or interface in java.lang.management">PlatformManagedObject</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ProcessorMXBean</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/PlatformManagedObject.html?is-external=true" target="_blank" title="class or interface in java.lang.management">PlatformManagedObject</a></pre>
<div class="block">Interface for managing Processor resources.
<br>
<table border="1">
<caption><b>Usage example for the <a href="../../../../com/ibm/lang/management/ProcessorMXBean.html" title="interface in com.ibm.lang.management"><code>ProcessorMXBean</code></a></b></caption>
<tr> <td>
<pre>
<code>
...
try {
mxbeanName = new ObjectName("com.ibm.lang.management:type=Processor");
} catch (MalformedObjectNameException e) {
// Exception Handling
}
try {
MBeanServer mbeanServer = ManagementFactory.getPlatformMBeanServer();
if (true != mbeanServer.isRegistered(mxbeanName)) {
// ProcessorMXBean not registered
}
ProcessorMXBean procBean = JMX.newMXBeanProxy(mbeanServer, mxbeanName, ProcessorMXBean.class);
} catch (Exception e) {
// Exception Handling
}
</code>
</pre></td></tr></table></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">
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/ProcessorMXBean.html#getNumberBoundCPUs--">getNumberBoundCPUs</a></span>()</code>
<div class="block">Returns the number of CPUs the process is bound to on the operating
system level.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/ProcessorMXBean.html#getNumberOnlineCPUs--">getNumberOnlineCPUs</a></span>()</code>
<div class="block">Returns the number of online CPUs as seen be the operating system
where the JVM is running.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/ProcessorMXBean.html#getNumberPhysicalCPUs--">getNumberPhysicalCPUs</a></span>()</code>
<div class="block">Returns the number of physical CPUs as seen by the operating system
where the Java Virtual Machine is running.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/ProcessorMXBean.html#getNumberTargetCPUs--">getNumberTargetCPUs</a></span>()</code>
<div class="block">Returns the target number of CPUs for the process.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/ProcessorMXBean.html#setNumberActiveCPUs-int-">setNumberActiveCPUs</a></span>(int&nbsp;number)</code>
<div class="block">Sets the number of CPUs that the process is specified to use.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.management.PlatformManagedObject">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.lang.management.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/PlatformManagedObject.html?is-external=true" target="_blank" title="class or interface in java.lang.management">PlatformManagedObject</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/PlatformManagedObject.html?is-external=true#getObjectName--" title="class or interface in java.lang.management">getObjectName</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getNumberPhysicalCPUs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumberPhysicalCPUs</h4>
<pre>int&nbsp;getNumberPhysicalCPUs()</pre>
<div class="block">Returns the number of physical CPUs as seen by the operating system
where the Java Virtual Machine is running.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of physical CPUs.</dd>
</dl>
</li>
</ul>
<a name="getNumberOnlineCPUs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumberOnlineCPUs</h4>
<pre>int&nbsp;getNumberOnlineCPUs()</pre>
<div class="block">Returns the number of online CPUs as seen be the operating system
where the JVM is running.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of online CPUs.</dd>
</dl>
</li>
</ul>
<a name="getNumberBoundCPUs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumberBoundCPUs</h4>
<pre>int&nbsp;getNumberBoundCPUs()</pre>
<div class="block">Returns the number of CPUs the process is bound to on the operating
system level.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of CPUs the process is bound to.</dd>
</dl>
</li>
</ul>
<a name="getNumberTargetCPUs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumberTargetCPUs</h4>
<pre>int&nbsp;getNumberTargetCPUs()</pre>
<div class="block">Returns the target number of CPUs for the process. This is normally
equal to <a href="../../../../com/ibm/lang/management/ProcessorMXBean.html#getNumberBoundCPUs--"><code>getNumberBoundCPUs()</code></a>, but is overridden by active
CPUs when it is set, e.g. using <a href="../../../../com/ibm/lang/management/ProcessorMXBean.html#setNumberActiveCPUs-int-"><code>setNumberActiveCPUs(int)</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of CPUs the process is entitled to.</dd>
</dl>
</li>
</ul>
<a name="setNumberActiveCPUs-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setNumberActiveCPUs</h4>
<pre>void&nbsp;setNumberActiveCPUs(int&nbsp;number)</pre>
<div class="block">Sets the number of CPUs that the process is specified to use.
<a href="../../../../com/ibm/lang/management/ProcessorMXBean.html#getNumberTargetCPUs--"><code>getNumberTargetCPUs()</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>number</code> - The number of CPUs to specify the process to use. The process
will behave as if <code>number</code> CPUs are available. If
this is set to 0, it will reset the number of CPUs specified
and the JVM will use the the number of CPUs detected on the system.</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/ProcessorMXBean.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/ProcessingCapacityNotificationInfo.html" title="class in com.ibm.lang.management"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/ibm/lang/management/ProcessorUsage.html" title="class 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/ProcessorMXBean.html" target="_top">Frames</a></li>
<li><a href="ProcessorMXBean.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>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></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/issues" target="_blank">Eclipse OpenJ9 issue.</a><br> Copyright &copy; 2001, 2020, IBM Corp. and others.</small></p>
</body>
</html>