Class AbstractOSThread

java.lang.Object

oshi.software.common.AbstractOSThread

All Implemented Interfaces:

OSThread

Direct Known Subclasses:

AixOSThread, DragonFlyBsdOSThread, FreeBsdOSThread, LinuxOSThread, MacOSThread, NetBsdOSThread, OpenBsdOSThread, SolarisOSThread, WindowsOSThread

@ThreadSafe
public abstract class AbstractOSThread
extends Object
implements OSThread

Common methods for OSThread implementation

Nested Class Summary

Nested classes/interfaces inherited from interface OSThread

OSThread.ThreadFiltering

Modifier and Type	Interface	Description
static final class	OSThread.ThreadFiltering	Constants which may be used to filter Thread lists

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractOSThread(int processId)	Creates an AbstractOSThread for the given owning process ID.

Method Summary

Modifier and Type	Method	Description
int	getOwningProcessId()	The owning process of this thread.
double	getThreadCpuLoadBetweenTicks(OSThread priorSnapshot)	Gets CPU usage of this thread since a previous snapshot of the same thread, provided as a parameter.
double	getThreadCpuLoadCumulative()	Gets cumulative CPU usage of this thread.
String	toString()

Methods inherited from class Object

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

Methods inherited from interface OSThread

getContextSwitches, getKernelTime, getMajorFaults, getMinorFaults, getName, getPriority, getStartMemoryAddress, getStartTime, getState, getThreadId, getUpTime, getUserTime, updateAttributes

Modifier and Type	Method	Description
default long	getContextSwitches()	A snapshot of the context switches the thread has done.
long	getKernelTime()	Kernel (privileged) time used by the thread.
default long	getMajorFaults()	The number of major (hard) faults the thread has made which have required loading a memory page from disk.
default long	getMinorFaults()	The number of minor (soft) faults the thread has made which have not required loading a memory page from disk.
default String	getName()	The name of the thread.
int	getPriority()	Priority of the thread, the meaning of which is dependent on the OS.
default long	getStartMemoryAddress()	The memory address above which this thread can run.
long	getStartTime()	The start time of the thread.
OSProcess.State	getState()	Gets the execution state of the task/thread.
int	getThreadId()	The thread id.
long	getUpTime()	Elapsed/up-time of the thread.
long	getUserTime()	User time used by the thread.
default boolean	updateAttributes()	Attempts to updates process attributes.

Constructor Details

AbstractOSThread

protected AbstractOSThread(int processId)

Creates an AbstractOSThread for the given owning process ID.

Parameters:

processId - the owning process ID

Method Details

getOwningProcessId

public int getOwningProcessId()

Description copied from interface: OSThread

The owning process of this thread. For single-threaded processes, the owning process ID may be the same as the thread's ID.

Specified by:

getOwningProcessId in interface OSThread

Returns:

The owning process of this thread.

getThreadCpuLoadCumulative

public double getThreadCpuLoadCumulative()

Description copied from interface: OSThread

Gets cumulative CPU usage of this thread.

Specified by:

getThreadCpuLoadCumulative in interface OSThread

Returns:

The proportion of up time that the thread was executing in kernel or user mode.

getThreadCpuLoadBetweenTicks

public double getThreadCpuLoadBetweenTicks(OSThread priorSnapshot)

Description copied from interface: OSThread

Gets CPU usage of this thread since a previous snapshot of the same thread, provided as a parameter.

Specified by:

getThreadCpuLoadBetweenTicks in interface OSThread

Parameters:

priorSnapshot - An OSThread object containing statistics for this same thread collected at a prior point in time. May be null.

Returns:

If the prior snapshot is for the same thread at a prior point in time, the proportion of elapsed up time between the current thread snapshot and the previous one that the thread was executing in kernel or user mode. Returns cumulative load otherwise.

toString

public String toString()

Overrides:

toString in class Object