Photon Server API Documentation v5.0RC1

Public Member Functions | Properties | List of all members
ExitGames.Diagnostics.Counter.CountsPerSecondCounter Class Reference

The counts per second rate counter. More...

Inheritance diagram for ExitGames.Diagnostics.Counter.CountsPerSecondCounter:
ExitGames.Diagnostics.Counter.CounterBase ExitGames.Diagnostics.Counter.ICounter

Public Member Functions

 CountsPerSecondCounter ()
 Initializes a new instance of the CountsPerSecondCounter class. More...
 
 CountsPerSecondCounter (string counterName)
 Initializes a new instance of the CountsPerSecondCounter class. More...
 
override long Decrement ()
 Decrements the sharedCounter. More...
 
override sealed RawCounterSample GetNextSample ()
 Gets the next sample. More...
 
override float GetNextValue ()
 Get the value since the last GetNextValue call. More...
 
override long Increment ()
 Increments the counter. More...
 
override long IncrementBy (long value)
 Increment the counter by a value. More...
 

Properties

override CounterType CounterType [get]
 Gets the type of the counter. More...
 
- Properties inherited from ExitGames.Diagnostics.Counter.CounterBase
abstract CounterType CounterType [get]
 Gets the type of the counter. More...
 
string Name [get]
 Gets Name. More...
 
bool IsValid [get, protected set]
 
- Properties inherited from ExitGames.Diagnostics.Counter.ICounter
CounterType CounterType [get]
 Gets the type of the counter. More...
 
string Name [get]
 Gets the name of the counter. More...
 
bool IsValid [get]
 Returns whether counter is valid or not For WindowsPerfCounters this method may return value whether counter exists or not More...
 

Additional Inherited Members

- Protected Member Functions inherited from ExitGames.Diagnostics.Counter.CounterBase
 CounterBase ()
 Initializes a new instance of the CounterBase class. More...
 
 CounterBase (string name)
 Initializes a new instance of the CounterBase class. More...
 

Detailed Description

The counts per second rate counter.

Constructor & Destructor Documentation

◆ CountsPerSecondCounter() [1/2]

ExitGames.Diagnostics.Counter.CountsPerSecondCounter.CountsPerSecondCounter ( )
inline

Initializes a new instance of the CountsPerSecondCounter class.

◆ CountsPerSecondCounter() [2/2]

ExitGames.Diagnostics.Counter.CountsPerSecondCounter.CountsPerSecondCounter ( string  counterName)
inline

Initializes a new instance of the CountsPerSecondCounter class.

Parameters
counterNameThe counterName.

Member Function Documentation

◆ Decrement()

override long ExitGames.Diagnostics.Counter.CountsPerSecondCounter.Decrement ( )
inlinevirtual

Decrements the sharedCounter.

Returns
The new value.

Implements ExitGames.Diagnostics.Counter.CounterBase.

◆ GetNextSample()

override sealed RawCounterSample ExitGames.Diagnostics.Counter.CountsPerSecondCounter.GetNextSample ( )
inlinevirtual

Gets the next sample.

Returns
A new RawCounterSample.

Implements ExitGames.Diagnostics.Counter.CounterBase.

◆ GetNextValue()

override float ExitGames.Diagnostics.Counter.CountsPerSecondCounter.GetNextValue ( )
inlinevirtual

Get the value since the last GetNextValue call.

Returns
A new RawCounterSample.

This method is NOT thread safe.

Implements ExitGames.Diagnostics.Counter.CounterBase.

◆ Increment()

override long ExitGames.Diagnostics.Counter.CountsPerSecondCounter.Increment ( )
inlinevirtual

Increments the counter.

Returns
The new value.

Implements ExitGames.Diagnostics.Counter.CounterBase.

◆ IncrementBy()

override long ExitGames.Diagnostics.Counter.CountsPerSecondCounter.IncrementBy ( long  value)
inlinevirtual

Increment the counter by a value.

Parameters
valueThe value.
Returns
The new value.

Implements ExitGames.Diagnostics.Counter.CounterBase.

Property Documentation

◆ CounterType

override CounterType ExitGames.Diagnostics.Counter.CountsPerSecondCounter.CounterType
get

Gets the type of the counter.

The type of the counter.