oshi.util.platform.windows

Class PerfCounterQuery<T extends Enum<T>>

java.lang.Object

oshi.util.platform.windows.PerfCounterQuery<T>

Direct Known Subclasses:

PerfCounterWildcardQuery

public class PerfCounterQuery<T extends Enum<T>>
extends Object

PerfCounterQuery class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PerfCounterQuery.CounterDataSource Source of performance counter data.
static interface	PerfCounterQuery.PdhCounterProperty Contract for Counter Property Enums

Field Summary

Fields

Modifier and Type	Field and Description
protected com.sun.jna.platform.win32.COM.WbemcliUtil.WmiQuery<T>	counterQuery
static String	NOT_TOTAL_INSTANCE Constant NOT_TOTAL_INSTANCE="^ + TOTAL_INSTANCE"
static String	NOT_TOTAL_INSTANCES Constant NOT_TOTAL_INSTANCES="^ + TOTAL_INSTANCES"
protected PerfCounterQueryHandler	pdhQueryHandler
protected String	perfObject
protected String	perfWmiClass
protected Class<T>	propertyEnum
protected String	queryKey
protected PerfCounterQuery.CounterDataSource	source
static String	TOTAL_INSTANCE Constant TOTAL_INSTANCE="_Total"
static String	TOTAL_INSTANCES Constant TOTAL_INSTANCES="*_Total"
protected WmiQueryHandler	wmiQueryHandler

Constructor Summary

Constructors

Constructor and Description
PerfCounterQuery(Class<T> propertyEnum, String perfObject, String perfWmiClass) Construct a new object to hold performance counter data source and results
PerfCounterQuery(Class<T> propertyEnum, String perfObject, String perfWmiClass, String queryKey) Construct a new object to hold performance counter data source and results

Method Summary

Modifier and Type	Method and Description
protected boolean	initPdhCounters() Initialize PDH counters for this data source.
protected void	initWmiCounters() Initialize the WMI query object needed to retrieve counters for this data source.
Map<T,Long>	queryValues() Query the current data source (PDH or WMI) for the Performance Counter values corresponding to the property enum.
boolean	setDataSource(PerfCounterQuery.CounterDataSource source) Set the Data Source for these counters
protected void	unInitPdhCounters() Uninitialize PDH counters for this data source.
protected void	unInitWmiCounters() Uninitializes the WMI query object needed to retrieve counters for this data source, allowing it to be garbage collected.

Methods inherited from class java.lang.Object

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

Field Detail

propertyEnum

protected final Class<T extends Enum<T>> propertyEnum

perfObject

protected final String perfObject

perfWmiClass

protected final String perfWmiClass

queryKey

protected final String queryKey

source

protected PerfCounterQuery.CounterDataSource source

pdhQueryHandler

protected PerfCounterQueryHandler pdhQueryHandler

wmiQueryHandler

protected WmiQueryHandler wmiQueryHandler

counterQuery

protected com.sun.jna.platform.win32.COM.WbemcliUtil.WmiQuery<T extends Enum<T>> counterQuery

TOTAL_INSTANCE

public static final String TOTAL_INSTANCE

Constant TOTAL_INSTANCE="_Total"

See Also:

Constant Field Values

TOTAL_INSTANCES

public static final String TOTAL_INSTANCES

Constant TOTAL_INSTANCES="*_Total"

See Also:

Constant Field Values

NOT_TOTAL_INSTANCE

public static final String NOT_TOTAL_INSTANCE

Constant NOT_TOTAL_INSTANCE="^ + TOTAL_INSTANCE"

See Also:

Constant Field Values

NOT_TOTAL_INSTANCES

public static final String NOT_TOTAL_INSTANCES

Constant NOT_TOTAL_INSTANCES="^ + TOTAL_INSTANCES"

See Also:

Constant Field Values

Constructor Detail

PerfCounterQuery

public PerfCounterQuery(Class<T> propertyEnum,
                        String perfObject,
                        String perfWmiClass)

Construct a new object to hold performance counter data source and results

Parameters:

propertyEnum - An enum which implements PerfCounterQuery.PdhCounterProperty and contains the WMI field (Enum value) and PDH Counter string (instance and counter)

perfObject - The PDH object for this counter; all counters on this object will be refreshed at the same time

perfWmiClass - The WMI PerfData_RawData_* class corresponding to the PDH object

PerfCounterQuery

public PerfCounterQuery(Class<T> propertyEnum,
                        String perfObject,
                        String perfWmiClass,
                        String queryKey)

Construct a new object to hold performance counter data source and results

Parameters:

propertyEnum - An enum which implements PerfCounterQuery.PdhCounterProperty and contains the WMI field (Enum value) and PDH Counter string (instance and counter)

perfObject - The PDH object for this counter; all counters on this object will be refreshed at the same time

perfWmiClass - The WMI PerfData_RawData_* class corresponding to the PDH object

queryKey - An optional key for PDH counter updates; defaults to the PDH object name

Method Detail

setDataSource

public boolean setDataSource(PerfCounterQuery.CounterDataSource source)

Set the Data Source for these counters

Parameters:

source - The source of data

Returns:

Whether the data source was successfully set

initPdhCounters

protected boolean initPdhCounters()

Initialize PDH counters for this data source. Adds necessary counters to a PDH Query.

Returns:

True if the counters were successfully added.

unInitPdhCounters

protected void unInitPdhCounters()

Uninitialize PDH counters for this data source. Removes necessary counters from the PDH Query, releasing their handles.

initWmiCounters

protected void initWmiCounters()

Initialize the WMI query object needed to retrieve counters for this data source.

unInitWmiCounters

protected void unInitWmiCounters()

Uninitializes the WMI query object needed to retrieve counters for this data source, allowing it to be garbage collected.

queryValues

public Map<T,Long> queryValues()

Query the current data source (PDH or WMI) for the Performance Counter values corresponding to the property enum.

Returns:

A map of the values by the counter enum.