Package oshi.util.platform.unix.solaris

Class KstatUtil

java.lang.Object
oshi.util.platform.unix.solaris.KstatUtil
@ThreadSafe
public final class KstatUtil
extends java.lang.Object
Provides access to kstat information on Solaris

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  KstatUtil.KstatChain
    A copy of the Kstat chain, encapsulating a kstat_ctl_t object.

  • Method Summary

    Modifier and Type Method Description
    static long dataLookupLong​(com.sun.jna.platform.unix.solaris.LibKstat.Kstat ksp, java.lang.String name)
    Convenience method for LibKstat.kstat_data_lookup(com.sun.jna.platform.unix.solaris.LibKstat.Kstat, java.lang.String) with numeric return values.
    static java.lang.String dataLookupString​(com.sun.jna.platform.unix.solaris.LibKstat.Kstat ksp, java.lang.String name)
    Convenience method for LibKstat.kstat_data_lookup(com.sun.jna.platform.unix.solaris.LibKstat.Kstat, java.lang.String) with String return values.
    static KstatUtil.KstatChain openChain()
    Create a copy of the Kstat chain and lock it for use by this object.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • openChain

      public static KstatUtil.KstatChain openChain()
      Create a copy of the Kstat chain and lock it for use by this object.
      Returns:
      A locked copy of the chain. It should be unlocked/released when you are done with it with KstatUtil.KstatChain.close().

    • dataLookupString

      public static java.lang.String dataLookupString​(com.sun.jna.platform.unix.solaris.LibKstat.Kstat ksp, java.lang.String name)
      Convenience method for LibKstat.kstat_data_lookup(com.sun.jna.platform.unix.solaris.LibKstat.Kstat, java.lang.String) with String return values. Searches the kstat's data section for the record with the specified name. This operation is valid only for kstat types which have named data records. Currently, only the KSTAT_TYPE_NAMED and KSTAT_TYPE_TIMER kstats have named data records.
      Parameters:
      ksp - The kstat to search
      name - The key for the name-value pair, or name of the timer as applicable
      Returns:
      The value as a String.

    • dataLookupLong

      public static long dataLookupLong​(com.sun.jna.platform.unix.solaris.LibKstat.Kstat ksp, java.lang.String name)
      Convenience method for LibKstat.kstat_data_lookup(com.sun.jna.platform.unix.solaris.LibKstat.Kstat, java.lang.String) with numeric return values. Searches the kstat's data section for the record with the specified name. This operation is valid only for kstat types which have named data records. Currently, only the KSTAT_TYPE_NAMED and KSTAT_TYPE_TIMER kstats have named data records.
      Parameters:
      ksp - The kstat to search
      name - The key for the name-value pair, or name of the timer as applicable
      Returns:
      The value as a long. If the data type is a character or string type, returns 0 and logs an error.