Class OpenBsdOperatingSystem

java.lang.Object

oshi.software.common.AbstractOperatingSystem

oshi.software.common.os.unix.bsd.BsdOperatingSystem

oshi.software.common.os.unix.openbsd.OpenBsdOperatingSystem

All Implemented Interfaces:

OperatingSystem

@ThreadSafe
public abstract class OpenBsdOperatingSystem
extends BsdOperatingSystem

Abstract base shared by the OpenBSD OperatingSystem implementations (JNA and FFM). The cross-BSD-common pieces live in BsdOperatingSystem; this layer adds the OpenBSD ps process enumeration, the ps -axHo tid thread count, the text-parsed boot time, and the (non-native) internet protocol stats and network params. The native bits (the OSProcess and FileSystem factories, getpid/getthrid, and the sysctl version query) are provided by the JNA and FFM subclasses.

Nested Class Summary

Nested classes/interfaces inherited from interface OperatingSystem

OperatingSystem.OSVersionInfo, OperatingSystem.ProcessFiltering, OperatingSystem.ProcessSorting

Modifier and Type	Interface	Description
static class	OperatingSystem.OSVersionInfo	A class representing the Operating System version details.
static final class	OperatingSystem.ProcessFiltering	Constants which may be used to filter Process lists in OperatingSystem.getProcesses(Predicate, Comparator, int), OperatingSystem.getChildProcesses(int, Predicate, Comparator, int), and OperatingSystem.getDescendantProcesses(int, Predicate, Comparator, int).
static final class	OperatingSystem.ProcessSorting	Constants which may be used to sort Process lists in OperatingSystem.getProcesses(Predicate, Comparator, int), OperatingSystem.getChildProcesses(int, Predicate, Comparator, int), and OperatingSystem.getDescendantProcesses(int, Predicate, Comparator, int).

Field Summary

Fields inherited from class AbstractOperatingSystem

USE_WHO_COMMAND

Modifier and Type	Field	Description
protected static final boolean	USE_WHO_COMMAND	Whether to use the 'who' command for session queries.

Constructor Summary

Constructors

Constructor	Description
OpenBsdOperatingSystem()

Method Summary

Modifier and Type	Method	Description
protected abstract OSProcess	createProcess(int pid, Map<BsdPsKeyword, String> psMap)	Creates a backend-specific OSProcess from a parsed ps row.
OSThread	getCurrentThread()	Makes a best effort to get the current thread.
InternetProtocolStats	getInternetProtocolStats()	Instantiates a InternetProtocolStats object.
NetworkParams	getNetworkParams()	Instantiates a NetworkParams object.
protected List<OSProcess>	getProcessListFromPS(int pid)	Enumerates processes (or a single process when pid >= 0) via the platform's ps command.
int	getThreadCount()	Get the number of threads currently running
protected long	queryBootTime()	Queries the system boot time in seconds since the epoch.

Methods inherited from class BsdOperatingSystem

getProcess, getProcessCount, getServices, getSystemBootTime, getSystemUptime, queryAllProcesses, queryBitness, queryChildProcesses, queryDescendantProcesses, queryManufacturer

Modifier and Type	Method	Description
OSProcess	getProcess(int pid)	Gets information on a currently running process
int	getProcessCount()	Get the number of processes currently running
List<OSService>	getServices()	Gets the all services on the system.
long	getSystemBootTime()	Get Unix time of boot.
long	getSystemUptime()	Get the System up time (time since boot).
List<OSProcess>	queryAllProcesses()	Queries all processes on the system.
protected int	queryBitness(int jvmBitness)	Backup OS-specific query to determine bitness if previous checks fail
List<OSProcess>	queryChildProcesses(int parentPid)	Queries the children of a process.
List<OSProcess>	queryDescendantProcesses(int parentPid)	Queries the descendants of a process.
String	queryManufacturer()	Queries the OS manufacturer.

Methods inherited from class AbstractOperatingSystem

getBitness, getChildProcesses, getChildrenOrDescendants, getChildrenOrDescendants, getDescendantProcesses, getDesktopWindows, getFamily, getManufacturer, getProcesses, getSessions, getVersionInfo, isElevated, queryFamilyVersionInfo, toString

Modifier and Type	Method	Description
int	getBitness()	Gets the bitness (32 or 64) of the operating system.
List<OSProcess>	getChildProcesses(int parentPid, Predicate<OSProcess> filter, Comparator<OSProcess> sort, int limit)	Gets currently running child processes of provided parent PID, optionally filtering, sorting, and limited to the top "N".
protected static Set<Integer>	getChildrenOrDescendants(Collection<OSProcess> allProcs, int parentPid, boolean allDescendants)	Utility method for subclasses to take a full process list as input and return the children or descendants of a particular process.
protected static Set<Integer>	getChildrenOrDescendants(Map<Integer,Integer> parentPidMap, int parentPid, boolean allDescendants)	Utility method for subclasses to take a map of pid to parent as input and return the children or descendants of a particular process.
List<OSProcess>	getDescendantProcesses(int parentPid, Predicate<OSProcess> filter, Comparator<OSProcess> sort, int limit)	Gets currently running processes of provided parent PID's descendants, including their children, the children's children, etc., optionally filtering, sorting, and limited to the top "N".
List<OSDesktopWindow>	getDesktopWindows(boolean visibleOnly)	Gets windows on the operating system's GUI desktop.
String	getFamily()	Get the Operating System family.
String	getManufacturer()	Get the Operating System manufacturer.
List<OSProcess>	getProcesses(Predicate<OSProcess> filter, Comparator<OSProcess> sort, int limit)	Gets currently running processes, optionally filtering, sorting, and limited to the top "N".
List<OSSession>	getSessions()	Gets currently logged in users.
OperatingSystem.OSVersionInfo	getVersionInfo()	Get Operating System version information.
boolean	isElevated()	Determine whether the current process has elevated permissions such as sudo / Administrator
protected abstract Pair<String, OperatingSystem.OSVersionInfo>	queryFamilyVersionInfo()	Queries the OS family and version info.
String	toString()

Methods inherited from class Object

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

Methods inherited from interface OperatingSystem

getCgroupInfo, getCurrentProcess, getFileSystem, getInstalledApplications, getProcesses, getProcesses, getProcessId, getThreadId

Modifier and Type	Method	Description
default CgroupInfo	getCgroupInfo()	Retrieves cgroup information for the current process.
default OSProcess	getCurrentProcess()	Gets the current process.
FileSystem	getFileSystem()	Instantiates a FileSystem object.
default List<ApplicationInfo>	getInstalledApplications()	Retrieves a list of installed applications on the system.
default List<OSProcess>	getProcesses()	Gets currently running processes.
default List<OSProcess>	getProcesses(Collection<Integer> pids)	Gets information on a Collection of currently running processes.
int	getProcessId()	Gets the current process ID (PID).
int	getThreadId()	Makes a best effort to get the current thread ID (TID).

Constructor Details

OpenBsdOperatingSystem

public OpenBsdOperatingSystem()

Method Details

getInternetProtocolStats

public InternetProtocolStats getInternetProtocolStats()

Description copied from interface: OperatingSystem

Instantiates a InternetProtocolStats object.

Returns:

a InternetProtocolStats object.

getNetworkParams

public NetworkParams getNetworkParams()

Description copied from interface: OperatingSystem

Instantiates a NetworkParams object.

Returns:

A NetworkParams object.

getProcessListFromPS

protected List<OSProcess> getProcessListFromPS(int pid)

Description copied from class: BsdOperatingSystem

Enumerates processes (or a single process when pid >= 0) via the platform's ps command.

Specified by:

getProcessListFromPS in class BsdOperatingSystem

Parameters:

pid - the process ID, or -1 for all processes

Returns:

the process list

getCurrentThread

public OSThread getCurrentThread()

Description copied from interface: OperatingSystem

Makes a best effort to get the current thread. May not be useful in a multithreaded environment. The thread returned may have been short lived and no longer exist.

On macOS, returns the oldest thread in the calling process.

Returns:

the current thread if known; an invalid thread otherwise.

getThreadCount

public int getThreadCount()

Description copied from interface: OperatingSystem

Get the number of threads currently running

Specified by:

getThreadCount in interface OperatingSystem

Overrides:

getThreadCount in class BsdOperatingSystem

Returns:

The number of threads running

queryBootTime

protected long queryBootTime()

Description copied from class: BsdOperatingSystem

Queries the system boot time in seconds since the epoch.

Specified by:

queryBootTime in class BsdOperatingSystem

Returns:

the boot time in seconds

createProcess

protected abstract OSProcess createProcess(int pid,
 Map<BsdPsKeyword, String> psMap)

Creates a backend-specific OSProcess from a parsed ps row.

Parameters:

pid - the process ID

psMap - the parsed ps columns for this process

Returns:

a new OSProcess