Photon Server API Documentation v5.0RC1

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

A dummy counter that does nothing. More...

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

Public Member Functions

 DummyCounter (string name)
 Initializes a new instance of the DummyCounter class. More...
 
override long Decrement ()
 Decrements the counter. More...
 
override RawCounterSample GetNextSample ()
 Gets the next sample. More...
 
override float GetNextValue ()
 Gets the next value. More...
 
override long Increment ()
 Increments the counter. More...
 
override long IncrementBy (long value)
 Increments the counter. 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

A dummy counter that does nothing.

Constructor & Destructor Documentation

◆ DummyCounter()

ExitGames.Diagnostics.Counter.DummyCounter.DummyCounter ( string  name)
inline

Initializes a new instance of the DummyCounter class.

Parameters
nameThe name.

Member Function Documentation

◆ Decrement()

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

Decrements the counter.

Returns
Always zero.

Implements ExitGames.Diagnostics.Counter.CounterBase.

◆ GetNextSample()

override RawCounterSample ExitGames.Diagnostics.Counter.DummyCounter.GetNextSample ( )
inlinevirtual

Gets the next sample.

Returns
A new RawCounterSample.

Implements ExitGames.Diagnostics.Counter.CounterBase.

◆ GetNextValue()

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

Gets the next value.

Returns
Always zero.

Implements ExitGames.Diagnostics.Counter.CounterBase.

◆ Increment()

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

Increments the counter.

Returns
Always zero.

Implements ExitGames.Diagnostics.Counter.CounterBase.

◆ IncrementBy()

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

Increments the counter.

Parameters
valueThe value.
Returns
Always zero.

Implements ExitGames.Diagnostics.Counter.CounterBase.

Property Documentation

◆ CounterType

override CounterType ExitGames.Diagnostics.Counter.DummyCounter.CounterType
get

Gets the type of the counter.

The type of the counter.