oshi.software.common

Class AbstractProcess

java.lang.Object

oshi.software.common.AbstractProcess

All Implemented Interfaces:

Serializable, OshiJsonObject, OSProcess

Direct Known Subclasses:

LinuxProcess, MacProcess, WindowsProcess

public class AbstractProcess
extends Object
implements OSProcess

A process is an instance of a computer program that is being executed. It contains the program code and its current activity. Depending on the operating system (OS), a process may be made up of multiple threads of execution that execute instructions concurrently.

Author:

widdis[at]gmail[dot]com

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface oshi.software.os.OSProcess

OSProcess.State

Field Summary

Fields

Modifier and Type	Field and Description
protected long	kernelTime
protected String	name
protected int	parentProcessID
protected String	path
protected int	priority
protected int	processID
protected long	residentSetSize
protected long	startTime
protected OSProcess.State	state
protected int	threadCount
protected long	upTime
protected long	userTime
protected long	virtualSize

Constructor Summary

Constructors

Constructor and Description
AbstractProcess()

Method Summary

Modifier and Type	Method and Description
long	getKernelTime()
String	getName()
int	getParentProcessID()
String	getPath()
int	getPriority()
int	getProcessID()
long	getResidentSetSize()
long	getStartTime()
OSProcess.State	getState()
int	getThreadCount()
long	getUpTime()
long	getUserTime()
long	getVirtualSize()
javax.json.JsonObject	toJSON() Creates a compact JSON string containing the information for this class

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

protected String name

path

protected String path

state

protected OSProcess.State state

processID

protected int processID

parentProcessID

protected int parentProcessID

threadCount

protected int threadCount

priority

protected int priority

virtualSize

protected long virtualSize

residentSetSize

protected long residentSetSize

kernelTime

protected long kernelTime

userTime

protected long userTime

startTime

protected long startTime

upTime

protected long upTime

Constructor Detail

AbstractProcess

public AbstractProcess()

Method Detail

getName

public String getName()

Specified by:

getName in interface OSProcess

Returns:

Returns the name of the process.

getPath

public String getPath()

Specified by:

getPath in interface OSProcess

Returns:

Returns the full path of the executing process.

getState

public OSProcess.State getState()

Specified by:

getState in interface OSProcess

Returns:

Returns the execution state of the process.

getProcessID

public int getProcessID()

Specified by:

getProcessID in interface OSProcess

Returns:

Returns the processID.

getParentProcessID

public int getParentProcessID()

Specified by:

getParentProcessID in interface OSProcess

Returns:

Returns the parentProcessID, if any; 0 otherwise.

getThreadCount

public int getThreadCount()

Specified by:

getThreadCount in interface OSProcess

Returns:

Returns the number of threads in this process.

getPriority

public int getPriority()

Specified by:

getPriority in interface OSProcess

Returns:

Returns the priority of this process. For Linux, priority is a value in the range -20 to 19 (20 on some systems). The default priority is 0; lower priorities cause more favorable scheduling. For Windows, priority values can range from 0 (lowest priority) to 31 (highest priority). Mac OS X has 128 priority levels, ranging from 0 (lowest priority) to 127 (highest priority). They are divided into several major bands: 0 through 51 are the normal levels; the default priority is 31. 52 through 79 are the highest priority regular threads; 80 through 95 are for kernel mode threads; and 96 through 127 correspond to real-time threads, which are treated differently than other threads by the scheduler.

getVirtualSize

public long getVirtualSize()

Specified by:

getVirtualSize in interface OSProcess

Returns:

Returns the Virtual Memory Size (VSZ). It includes all memory that the process can access, including memory that is swapped out and memory that is from shared libraries.

getResidentSetSize

public long getResidentSetSize()

Specified by:

getResidentSetSize in interface OSProcess

Returns:

Returns the Resident Set Size (RSS). It is used to show how much memory is allocated to that process and is in RAM. It does not include memory that is swapped out. It does include memory from shared libraries as long as the pages from those libraries are actually in memory. It does include all stack and heap memory.

getKernelTime

public long getKernelTime()

Specified by:

getKernelTime in interface OSProcess

Returns:

Returns the number of milliseconds the process has executed in kernel mode.

getUserTime

public long getUserTime()

Specified by:

getUserTime in interface OSProcess

Returns:

Returns the number of milliseconds the process has executed in user mode.

getUpTime

public long getUpTime()

Specified by:

getUpTime in interface OSProcess

Returns:

Returns the number of milliseconds since the process started.

getStartTime

public long getStartTime()

Specified by:

getStartTime in interface OSProcess

Returns:

Returns the start time of the process in number of milliseconds since January 1, 1970.

toJSON

public javax.json.JsonObject toJSON()

Creates a compact JSON string containing the information for this class

Specified by:

toJSON in interface OshiJsonObject

Returns:

a compact JSON string