oshi.software.os

Interface OSProcess

All Superinterfaces:

OshiJsonObject, Serializable

All Known Implementing Classes:

AbstractProcess, LinuxProcess, MacProcess, WindowsProcess

public interface OSProcess
extends OshiJsonObject

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OSProcess.State Process Execution States

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()

Methods inherited from interface oshi.json.OshiJsonObject

toJSON

Method Detail

getName

String getName()

Returns:

Returns the name of the process.

getPath

String getPath()

Returns:

Returns the full path of the executing process.

getState

OSProcess.State getState()

Returns:

Returns the execution state of the process.

getProcessID

int getProcessID()

Returns:

Returns the processID.

getParentProcessID

int getParentProcessID()

Returns:

Returns the parentProcessID, if any; 0 otherwise.

getThreadCount

int getThreadCount()

Returns:

Returns the number of threads in this process.

getPriority

int getPriority()

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

long getVirtualSize()

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

long getResidentSetSize()

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

long getKernelTime()

Returns:

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

getUserTime

long getUserTime()

Returns:

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

getUpTime

long getUpTime()

Returns:

Returns the number of milliseconds since the process started.

getStartTime

long getStartTime()

Returns:

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