Class BsdOSThread

java.lang.Object
oshi.software.common.AbstractOSThread
oshi.software.common.os.unix.bsd.BsdOSThread
All Implemented Interfaces:
OSThread
Direct Known Subclasses:
DragonFlyBsdOSThread, FreeBsdOSThread, NetBsdOSThread, OpenBsdOSThread
@ThreadSafe public abstract class BsdOSThread extends AbstractOSThread
Abstract base shared by the BSD-family OSThread implementations (FreeBSD, OpenBSD, DragonFly, NetBSD). Holds the field storage, the trivial accessors, and the shared ps thread-row parsing. Differences in the available columns (thread-id keyword, name, elapsed/cpu time, thread address) are handled by checking which keys are present. Platform-specific work (the ordered column list and the ps command used to refresh a single thread) is provided by the per-platform subclasses.

  • Field Details

    • threadId

      protected int threadId

    • name

      protected String name

    • state

      protected OSProcess.State state

    • minorFaults

      protected long minorFaults

    • majorFaults

      protected long majorFaults

    • startMemoryAddress

      protected long startMemoryAddress

    • contextSwitches

      protected long contextSwitches

    • kernelTime

      protected long kernelTime

    • userTime

      protected long userTime

    • startTime

      protected long startTime

    • upTime

      protected long upTime

    • priority

      protected int priority

  • Constructor Details

    • BsdOSThread

      protected BsdOSThread(int processId)

  • Method Details

    • getThreadId

      public int getThreadId()
      Description copied from interface: OSThread
      The thread id. The meaning of this value is OS-dependent.
      Returns:
      Returns the id of the thread.

    • getName

      public String getName()
      Description copied from interface: OSThread
      The name of the thread. Presence of a name is operating-system dependent and may include information (such as an index of running threads) that changes during execution.
      Returns:
      Returns the name of the task/thread.

    • getState

      public OSProcess.State getState()
      Description copied from interface: OSThread
      Gets the execution state of the task/thread.
      Returns:
      Returns the execution state of the task/thread.

    • getStartMemoryAddress

      public long getStartMemoryAddress()
      Description copied from interface: OSThread
      The memory address above which this thread can run.
      Returns:
      The start address.

    • getContextSwitches

      public long getContextSwitches()
      Description copied from interface: OSThread
      A snapshot of the context switches the thread has done. Since the context switches could be voluntary and non-voluntary, this gives the sum of both.

      Not available on AIX.

      Returns:
      sum of both voluntary and involuntary context switches.

    • getMinorFaults

      public long getMinorFaults()
      Description copied from interface: OSThread
      The number of minor (soft) faults the thread has made which have not required loading a memory page from disk. Sometimes called reclaims. Linux only.
      Returns:
      minor faults.

    • getMajorFaults

      public long getMajorFaults()
      Description copied from interface: OSThread
      The number of major (hard) faults the thread has made which have required loading a memory page from disk. Linux only.
      Returns:
      major faults.

    • getKernelTime

      public long getKernelTime()
      Description copied from interface: OSThread
      Kernel (privileged) time used by the thread.
      Returns:
      Returns the number of milliseconds the task/thread has executed in kernel/system mode.

    • getUserTime

      public long getUserTime()
      Description copied from interface: OSThread
      User time used by the thread.
      Returns:
      Returns the number of milliseconds the task/thread has executed in user mode.

    • getUpTime

      public long getUpTime()
      Description copied from interface: OSThread
      Elapsed/up-time of the thread.
      Returns:
      Returns the number of milliseconds since the task/thread started.

    • getStartTime

      public long getStartTime()
      Description copied from interface: OSThread
      The start time of the thread.
      Returns:
      Returns the start time of the task/thread in number of milliseconds since January 1, 1970.

    • getPriority

      public int getPriority()
      Description copied from interface: OSThread
      Priority of the thread, the meaning of which is dependent on the OS.
      Returns:
      priority.

    • updateAttributes

      public boolean updateAttributes()
      Description copied from interface: OSThread
      Attempts to updates process attributes. Returns false if the update fails, which will occur if the process no longer exists. Not implemented for macOS, as thread ID is simply an index and not unique.
      Returns:
      true if the update was successful, false if the update failed. In addition, on a failed update the thread state will be changed to OSProcess.State.INVALID.

    • updateAttributes

      protected boolean updateAttributes(Map<BsdPsThreadKeyword, String> threadMap)
      Populates this thread's attributes from a parsed ps thread row. Shared by every BSD platform; differences in the available columns are handled by checking which keys are present in the map.
      Parameters:
      threadMap - the parsed ps columns for this thread
      Returns:
      true once the attributes are populated

    • psThreadKeywords

      protected abstract List<BsdPsThreadKeyword> psThreadKeywords()
      Returns this platform's ordered ps thread column keys, used to parse thread rows positionally.
      Returns:
      the ordered thread column keys

    • psThreadCommand

      protected abstract String psThreadCommand()
      Returns the ps command (without the trailing -p <pid>) used to enumerate this process's threads when refreshing a single thread.
      Returns:
      the ps command prefix