Package oshi.util.platform.windows
Class PerfDataUtil
java.lang.Object
oshi.util.platform.windows.PerfDataUtil
Helper class to centralize the boilerplate portions of PDH counter setup and
allow applications to easily add, query, and remove counters.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Encapsulates the three string components of a performance counter -
Method Summary
Modifier and TypeMethodDescriptionstatic boolean
addCounter(com.sun.jna.platform.win32.WinNT.HANDLEByReference query, String path, com.sun.jna.platform.win32.WinNT.HANDLEByReference p)
Adds a pdh counter to a querystatic boolean
closeQuery(com.sun.jna.platform.win32.WinNT.HANDLEByReference q)
Close a pdh querystatic PerfDataUtil.PerfCounter
createCounter(String object, String instance, String counter)
Create a Performance Counterstatic boolean
openQuery(com.sun.jna.platform.win32.WinNT.HANDLEByReference q)
Open a pdh querystatic long
queryCounter(com.sun.jna.platform.win32.WinNT.HANDLEByReference counter)
Get value of pdh counterstatic boolean
removeCounter(com.sun.jna.platform.win32.WinNT.HANDLEByReference p)
Remove a pdh counterstatic long
updateQueryTimestamp(com.sun.jna.platform.win32.WinNT.HANDLEByReference query)
Update a query and get the timestamp
-
Method Details
-
createCounter
public static PerfDataUtil.PerfCounter createCounter(String object, String instance, String counter)Create a Performance Counter- Parameters:
object
- The object/path for the counterinstance
- The instance of the counter, or null if no instancecounter
- The counter name- Returns:
- A PerfCounter object encapsulating the object, instance, and counter
-
updateQueryTimestamp
public static long updateQueryTimestamp(com.sun.jna.platform.win32.WinNT.HANDLEByReference query)Update a query and get the timestamp- Parameters:
query
- The query to update all counters in- Returns:
- The update timestamp of the first counter in the query
-
openQuery
public static boolean openQuery(com.sun.jna.platform.win32.WinNT.HANDLEByReference q)Open a pdh query- Parameters:
q
- pointer to the query- Returns:
- true if successful
-
closeQuery
public static boolean closeQuery(com.sun.jna.platform.win32.WinNT.HANDLEByReference q)Close a pdh query- Parameters:
q
- pointer to the query- Returns:
- true if successful
-
queryCounter
public static long queryCounter(com.sun.jna.platform.win32.WinNT.HANDLEByReference counter)Get value of pdh counter- Parameters:
counter
- The counter to get the value of- Returns:
- long value of the counter, or negative value representing an error code
-
addCounter
public static boolean addCounter(com.sun.jna.platform.win32.WinNT.HANDLEByReference query, String path, com.sun.jna.platform.win32.WinNT.HANDLEByReference p)Adds a pdh counter to a query- Parameters:
query
- Pointer to the query to add the counterpath
- String name of the PerfMon counter. For Vista+, must be in English. Must localize this path for pre-Vista.p
- Pointer to the counter- Returns:
- true if successful
-
removeCounter
public static boolean removeCounter(com.sun.jna.platform.win32.WinNT.HANDLEByReference p)Remove a pdh counter- Parameters:
p
- pointer to the counter- Returns:
- true if successful
-