A read only ICounter that wraps a windows PerformanceCounter.
More...
A read only ICounter that wraps a windows PerformanceCounter.
◆ PerformanceCounterReader() [1/2]
ExitGames.Diagnostics.Counter.PerformanceCounterReader.PerformanceCounterReader |
( |
string |
categoryName, |
|
|
string |
counterName |
|
) |
| |
|
inline |
Initializes a new instance of the PerformanceCounterReader class.
- Parameters
-
categoryName | The name of the performance counter category. |
counterName | The performance counter name counter. |
◆ PerformanceCounterReader() [2/2]
ExitGames.Diagnostics.Counter.PerformanceCounterReader.PerformanceCounterReader |
( |
string |
categoryName, |
|
|
string |
counterName, |
|
|
string |
instanceName |
|
) |
| |
|
inline |
Initializes a new instance of the PerformanceCounterReader class.
- Parameters
-
categoryName | The name of the performance counter category. |
counterName | The performance counter name counter. |
instanceName | The instance name for the performance counter. |
◆ Decrement()
long ExitGames.Diagnostics.Counter.PerformanceCounterReader.Decrement |
( |
| ) |
|
|
inline |
◆ Dispose()
void ExitGames.Diagnostics.Counter.PerformanceCounterReader.Dispose |
( |
| ) |
|
|
inline |
Releases all resources used by this instance.
◆ GetNextValue()
float ExitGames.Diagnostics.Counter.PerformanceCounterReader.GetNextValue |
( |
| ) |
|
|
inline |
Obtains a counter sample and returns the calculated value for it.
- Returns
- The next calculated value that the system obtains for this counter.
Implements ExitGames.Diagnostics.Counter.ICounter.
◆ Increment()
long ExitGames.Diagnostics.Counter.PerformanceCounterReader.Increment |
( |
| ) |
|
|
inline |
◆ IncrementBy()
long ExitGames.Diagnostics.Counter.PerformanceCounterReader.IncrementBy |
( |
long |
value | ) |
|
|
inline |
◆ Initialize()
void ExitGames.Diagnostics.Counter.PerformanceCounterReader.Initialize |
( |
| ) |
|
|
inline |
Initalizes this instance. There is usally no need to call this method since the constructor has already taken care of it.
◆ TryGetValue()
bool ExitGames.Diagnostics.Counter.PerformanceCounterReader.TryGetValue |
( |
out float |
value | ) |
|
|
inline |
Tries to obtain a counter sample and returns the calculated value for it.
- Parameters
-
value | When this method returns, contains the calculated value for the performance counter if the the performance counter exists; otherwise, the default value for the type of the value parameter is returned. |
- Returns
- True if performcae counter exists and the calcualted value could be obtained; otherwise, false.
◆ CategoryExists
bool ExitGames.Diagnostics.Counter.PerformanceCounterReader.CategoryExists |
|
get |
Gets a value indicating whether the given performance counter category exists.
◆ CategoryName
string ExitGames.Diagnostics.Counter.PerformanceCounterReader.CategoryName |
|
get |
Gets the name of the performance counter category for the performance counter.
◆ CounterExists
bool ExitGames.Diagnostics.Counter.PerformanceCounterReader.CounterExists |
|
get |
Gets a value indicating whether the given performance counter exists.
◆ CounterType
CounterType ExitGames.Diagnostics.Counter.PerformanceCounterReader.CounterType |
|
get |
Gets the counter type of the associated performance counter.
◆ InstanceExists
bool ExitGames.Diagnostics.Counter.PerformanceCounterReader.InstanceExists |
|
get |
Gets a value indicating whether the given performance counter instance exists.
◆ InstanceName
string ExitGames.Diagnostics.Counter.PerformanceCounterReader.InstanceName |
|
get |
Gets the instance name for the performance counter.
◆ IsSingleInstance
bool ExitGames.Diagnostics.Counter.PerformanceCounterReader.IsSingleInstance |
|
get |
Gets a value indicating whether the performance counter category can have only a single instance.
◆ IsValid
bool ExitGames.Diagnostics.Counter.PerformanceCounterReader.IsValid |
|
get |
◆ Name
string ExitGames.Diagnostics.Counter.PerformanceCounterReader.Name |
|
get |
Gets the name of the counter.