oshi.hardware

Interface CentralProcessor

All Superinterfaces:

OshiJsonObject, Serializable

All Known Implementing Classes:

AbstractCentralProcessor, LinuxCentralProcessor, MacCentralProcessor, WindowsCentralProcessor

public interface CentralProcessor
extends OshiJsonObject

The Central Processing Unit (CPU) or the processor is the portion of a computer system that carries out the instructions of a computer program, and is the primary element carrying out the computer's functions.

Author:

dblock[at]dblock[dot]org

Method Summary

Modifier and Type	Method and Description
String	getFamily()
String	getIdentifier() Identifier, eg.
int	getLogicalProcessorCount() Get the number of logical CPUs available for processing.
String	getModel()
String	getName() Name, eg.
int	getPhysicalProcessorCount() Get the number of physical CPUs/cores available for processing.
OSProcess	getProcess(int pid) Gets information on a currently running process
int	getProcessCount() Get the number of processes currently running
OSProcess[]	getProcesses() Gets currently running processes
int	getProcessId() Gets the current process ID
double[]	getProcessorCpuLoadBetweenTicks() Returns the "recent cpu usage" for all logical processors by counting ticks for the processors from getProcessorCpuLoadTicks() between successive calls of this method, with a minimum interval slightly less than 1 second.
long[][]	getProcessorCpuLoadTicks() Get Processor CPU Load tick counters.
String	getStepping()
double	getSystemCpuLoad() Returns the "recent cpu usage" for the whole system from OperatingSystemMXBean.getSystemCpuLoad() if a user is running the Oracle JVM.
double	getSystemCpuLoadBetweenTicks() Returns the "recent cpu usage" for the whole system by counting ticks from getSystemCpuLoadTicks() between successive calls of this method, with a minimum interval slightly less than 1 second.
long[]	getSystemCpuLoadTicks() Get System-wide CPU Load tick counters.
long	getSystemIOWaitTicks() Get System IOWait tick counters (if available on that Operating System).
long[]	getSystemIrqTicks() Get System IRQ tick counters (if available on that Operating System).
double	getSystemLoadAverage() Returns the system load average for the last minute.
double[]	getSystemLoadAverage(int nelem) Returns the system load average for the number of elements specified, up to 3, representing 1, 5, and 15 minutes.
String	getSystemSerialNumber() Get the System/CPU Serial Number, if available.
long	getSystemUptime() Get the System uptime (time since boot).
int	getThreadCount() Get the number of threads currently running
String	getVendor() Processor vendor.
long	getVendorFreq() Vendor frequency (in Hz), eg.
boolean	isCpu64bit() Is CPU 64bit?
void	setCpu64(boolean cpu64) Set flag is cpu is 64bit.
void	setFamily(String _family)
void	setIdentifier(String identifier) Set processor identifier.
void	setModel(String _model)
void	setName(String name) Set processor name.
void	setStepping(String _stepping)
void	setVendor(String vendor) Set processor vendor.
void	setVendorFreq(long freq) Set processor vendor frequency (in Hz).

Methods inherited from interface oshi.json.OshiJsonObject

toJSON

Method Detail

getVendor

String getVendor()

Processor vendor.

Returns:

vendor string.

setVendor

void setVendor(String vendor)

Set processor vendor.

Parameters:

vendor - Vendor.

getName

String getName()

Name, eg. Intel(R) Core(TM)2 Duo CPU T7300 @ 2.00GHz

Returns:

Processor name.

setName

void setName(String name)

Set processor name.

Parameters:

name - Name.

getVendorFreq

long getVendorFreq()

Vendor frequency (in Hz), eg. for processor named Intel(R) Core(TM)2 Duo CPU T7300 @ 2.00GHz the vendor frequency is 2000000000.

Returns:

Processor frequency or -1 if unknown.

setVendorFreq

void setVendorFreq(long freq)

Set processor vendor frequency (in Hz).

Parameters:

freq - Frequency.

getIdentifier

String getIdentifier()

Identifier, eg. x86 Family 6 Model 15 Stepping 10.

Returns:

Processor identifier.

setIdentifier

void setIdentifier(String identifier)

Set processor identifier.

Parameters:

identifier - Identifier.

isCpu64bit

boolean isCpu64bit()

Is CPU 64bit?

Returns:

True if cpu is 64bit.

setCpu64

void setCpu64(boolean cpu64)

Set flag is cpu is 64bit.

Parameters:

cpu64 - True if cpu is 64.

getStepping

String getStepping()

Returns:

the _stepping

setStepping

void setStepping(String _stepping)

Parameters:

_stepping - the _stepping to set

getModel

String getModel()

Returns:

the _model

setModel

void setModel(String _model)

Parameters:

_model - the _model to set

getFamily

String getFamily()

Returns:

the _family

setFamily

void setFamily(String _family)

Parameters:

_family - the _family to set

getSystemCpuLoadBetweenTicks

double getSystemCpuLoadBetweenTicks()

Returns the "recent cpu usage" for the whole system by counting ticks from getSystemCpuLoadTicks() between successive calls of this method, with a minimum interval slightly less than 1 second. If less than one second has elapsed since the last call of this method, it will return a calculation based on the tick counts and times of the previous two calls. If at least a second has elapsed, it will return the average CPU load for the interval and update the "last called" times. This method is intended to be used for periodic polling at intervals of 1 second or longer.

Returns:

CPU load between 0 and 1 (100%)

getSystemCpuLoadTicks

long[] getSystemCpuLoadTicks()

Get System-wide CPU Load tick counters. Returns an array with four elements representing clock ticks or milliseconds (platform dependent) spent in User (0), Nice (1), System (2), and Idle (3) states. By measuring the difference between ticks across a time interval, CPU load over that interval may be calculated. The Idle time for this method includes system time spent idle waiting for IO as reported by getSystemIOWaitTicks(). The system time includes system time spent servicing Hardware and Software IRQ requests as reported by getSystemIrqTicks() as well as executing other virtual hosts (steal) or running a virtual cpu (guest).

Returns:

An array of 4 long values representing time spent in User, Nice(if applicable), System, and Idle states.

getSystemIOWaitTicks

long getSystemIOWaitTicks()

Get System IOWait tick counters (if available on that Operating System). Time spent waiting for IO to complete is included in the idle time calculated by getSystemCpuLoadTicks() but is provided separately for more detail.

Returns:

a long value representing time spent idle waiting for IO to complete.

getSystemIrqTicks

long[] getSystemIrqTicks()

Get System IRQ tick counters (if available on that Operating System). Time spent servicing hardware and software (Deferred Procedure Call) interrupts is included in the system time calculated by getSystemCpuLoadTicks() but is provided separately for more detail.

Returns:

an array of two long values representing time spent servicing hardware interrupts and software interrupts (DPC)

getSystemCpuLoad

double getSystemCpuLoad()

Returns the "recent cpu usage" for the whole system from OperatingSystemMXBean.getSystemCpuLoad() if a user is running the Oracle JVM. This value is a double in the [0.0,1.0] interval. A value of 0.0 means that all CPUs were idle during the recent period of time observed, while a value of 1.0 means that all CPUs were actively running 100% of the time during the recent period being observed. All values between 0.0 and 1.0 are possible depending of the activities going on in the system. If the system recent cpu usage is not available, the method returns a negative value. Calling this method immediately upon instantiating the CentralProcessor may give unreliable results. If a user is not running the Oracle JVM, this method will default to the behavior and return value of getSystemCpuLoadBetweenTicks().

Returns:

the "recent cpu usage" for the whole system; a negative value if not available.

getSystemLoadAverage

double getSystemLoadAverage()

Returns the system load average for the last minute. This is equivalent to calling getSystemLoadAverage(int) with an argument of 1 and returning the first value, and is retained for compatibility.

Returns:

the system load average; or a negative value if not available.

getSystemLoadAverage

double[] getSystemLoadAverage(int nelem)

Returns the system load average for the number of elements specified, up to 3, representing 1, 5, and 15 minutes. The system load average is the sum of the number of runnable entities queued to the available processors and the number of runnable entities running on the available processors averaged over a period of time. The way in which the load average is calculated is operating system specific but is typically a damped time-dependent average. If the load average is not available, a negative value is returned. This method is designed to provide a hint about the system load and may be queried frequently. The load average may be unavailable on some platforms (e.g., Windows) where it is expensive to implement this method.

Parameters:

nelem - Number of elements to return.

Returns:

an array of the system load averages for 1, 5, and 15 minutes with the size of the array specified by nelem; or negative values if not available.

getProcessorCpuLoadBetweenTicks

double[] getProcessorCpuLoadBetweenTicks()

Returns the "recent cpu usage" for all logical processors by counting ticks for the processors from getProcessorCpuLoadTicks() between successive calls of this method, with a minimum interval slightly less than 1 second. If less than one second has elapsed since the last call of this method, it will return a calculation based on the tick counts and times of the previous two calls. If at least a second has elapsed, it will return the average CPU load for the interval and update the "last called" times. This method is intended to be used for periodic polling (iterating over all processors) at intervals of 1 second or longer.

Returns:

array of CPU load between 0 and 1 (100%) for each logical processor

getProcessorCpuLoadTicks

long[][] getProcessorCpuLoadTicks()

Get Processor CPU Load tick counters. Returns a two dimensional array, with getLogicalProcessorCount() arrays, each containing four elements representing clock ticks or milliseconds (platform dependent) spent in User (0), Nice (1), System (2), and Idle (3) states. By measuring the difference between ticks across a time interval, CPU load over that interval may be calculated. The Idle time for this method includes processor time spent idle waiting for IO as reported by getSystemIOWaitTicks(). The system time includes processor time spent servicing Hardware IRQ requests as reported by getSystemIrqTicks() as well as Software IRQ requests (softirq), executing other virtual hosts (steal) or running a virtual cpu (guest).

Returns:

A 2D array of logicalProcessorCount x 4 long values representing time spent in User, Nice(if applicable), System, and Idle states.

getSystemUptime

long getSystemUptime()

Get the System uptime (time since boot).

Returns:

Number of seconds since boot.

getSystemSerialNumber

String getSystemSerialNumber()

Get the System/CPU Serial Number, if available. On Linux, this requires either root permissions, or installation of the (deprecated) HAL library (lshal command).

Returns:

the System/CPU Serial Number, if available, otherwise returns "unknown"

getLogicalProcessorCount

int getLogicalProcessorCount()

Get the number of logical CPUs available for processing.

Returns:

The number of logical CPUs available.

getPhysicalProcessorCount

int getPhysicalProcessorCount()

Get the number of physical CPUs/cores available for processing.

Returns:

The number of physical CPUs available.

getProcesses

OSProcess[] getProcesses()

Gets currently running processes

Returns:

An array of OSProcess objects for currently running processes

getProcess

OSProcess getProcess(int pid)

Gets information on a currently running process

Parameters:

pid - A process ID

Returns:

An OSProcess object for the specified process id if it is running; null otherwise currently running processes

getProcessId

int getProcessId()

Gets the current process ID

Returns:

the Process ID of the current process

getProcessCount

int getProcessCount()

Get the number of processes currently running

Returns:

The number of processes running

getThreadCount

int getThreadCount()

Get the number of threads currently running

Returns:

The number of threads running