Class ProcessorUsage
java.lang.Object
com.ibm.lang.management.ProcessorUsage
This represents a snapshot of the Operating System level Processor usage statistics.
The statistics could be at an individual Processor level or an aggregate across all
Processors. The statistics are available on AIX, Linux and Windows.
- This information is not available on z/OS.
- Since:
- 1.7.1
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ProcessorUsage
from
(CompositeData cd) Receives aCompositeData
representing aProcessorUsage
object and attempts to return the rootProcessorUsage
instance.long
getBusy()
The time spent by the Processor executing a non-idle thread in microseconds.int
getId()
A unique identifier assigned to the this Processor.long
getIdle()
The time spent by the Processor sitting idle in microseconds.int
The online/offline status of this Processor.long
The time spent in system mode in microseconds.long
The timestamp when usage statistics were last sampled in microseconds.long
getUser()
The time spent in user mode in microseconds.long
getWait()
The time spent by the Processor in Input/Output (IO) wait in microseconds.toString()
Text description of thisProcessorUsage
object.
-
Constructor Details
-
ProcessorUsage
public ProcessorUsage()Creates a newProcessorUsage
instance.
-
-
Method Details
-
getUser
public long getUser()The time spent in user mode in microseconds.- Returns:
- The user times in microseconds or -1 if not available.
-
getSystem
public long getSystem()The time spent in system mode in microseconds.- Returns:
- The system times in microseconds or -1 if not available.
-
getIdle
public long getIdle()The time spent by the Processor sitting idle in microseconds.- Returns:
- The idle times in microseconds or -1 if not available.
-
getWait
public long getWait()The time spent by the Processor in Input/Output (IO) wait in microseconds.- Returns:
- The wait times in microseconds or -1 if not available.
-
getBusy
public long getBusy()The time spent by the Processor executing a non-idle thread in microseconds.- Returns:
- The busy times in microseconds or -1 if not available.
-
getId
public int getId()A unique identifier assigned to the this Processor. This is -1 if method invoked on the global Processor record.- Returns:
- An identifier for this Processor or -1 for the global record or if not available.
-
getOnline
public int getOnline()The online/offline status of this Processor. This is -1 if method invoked on the global Processor record or if this info is unavailable.- On AIX the online value is not reliable. Once a Processor becomes online, the status of the Processor will always be shown as online from that point onwards, even if it is currently offline. This is a limitation of the OS. Similarly offline on AIX means that the Processor was never online.
- Returns:
- This Processor's online status (0 = offline, 1 = online) or -1 for the global record or if not available.
-
getTimestamp
public long getTimestamp()The timestamp when usage statistics were last sampled in microseconds.- Returns:
- Timestamp in microseconds.
-
from
Receives aCompositeData
representing aProcessorUsage
object and attempts to return the rootProcessorUsage
instance.- Parameters:
cd
- ACompositeData
that represents aProcessorUsage
- Returns:
- if
cd
is non-null
, returns a new instance ofProcessorUsage
, Ifcd
isnull
, returnsnull
. - Throws:
IllegalArgumentException
- if argumentcd
does not correspond to aProcessorUsage
with the following attributes:user
(java.lang.Long
)system
(java.lang.Long
)idle
(java.lang.Long
)wait
(java.lang.Long
)busy
(java.lang.Long
)id
(java.lang.Integer
)online
(java.lang.Integer
)timestamp
(java.lang.Long
)
-
toString
Text description of thisProcessorUsage
object.- Overrides:
toString
in classObject
- Returns:
- Text description of this
ProcessorUsage
object.
-