Photon Server API Documentation v5.0RC1

Public Member Functions | Properties | List of all members
Photon.SocketServer.Diagnostics.Counters.PerfCounterAttribute Class Reference

Attribute for defining performance counters in ExtendedPerfCounterManagerBase children More...

Inheritance diagram for Photon.SocketServer.Diagnostics.Counters.PerfCounterAttribute:
Photon.SocketServer.Diagnostics.ExtPerfCounterAttribute

Public Member Functions

 PerfCounterAttribute (string name, PerformanceCounterType type, string description="", string categoryName=null)
 Initializes a new instance of the PerfCounterAttribute class. More...
 
 PerfCounterAttribute (string name, PerformanceCounterType type, PerformanceCounterInstanceLifetime counterLifetime, string description="", string categoryName=null)
 Initializes a new instance of the PerfCounterAttribute class. More...
 

Properties

string Name [get]
 Name of counter More...
 
string Description [get]
 Counter description More...
 
PerformanceCounterType Type [get]
 Type of system performance counter More...
 
string CategoryName [get, set]
 To which part counter applies: CounterCategory.Connection or CounterCategory.Server More...
 
PerformanceCounterInstanceLifetime? CounterLifetime [get]
 Counter instance lifetime. Takes precedence over PerfCounterCategoryAttribute.CategoryInstanceLifetime if specified. More...
 

Detailed Description

Attribute for defining performance counters in ExtendedPerfCounterManagerBase children

Constructor & Destructor Documentation

◆ PerfCounterAttribute() [1/2]

Photon.SocketServer.Diagnostics.Counters.PerfCounterAttribute.PerfCounterAttribute ( string  name,
PerformanceCounterType  type,
string  description = "",
string  categoryName = null 
)
inline

Initializes a new instance of the PerfCounterAttribute class.

Parameters
nameName of counter
typeType of system performance counter
descriptionCounter description
categoryNameTo which part counter applies: CounterCategory.Connection or CounterCategory.Server

◆ PerfCounterAttribute() [2/2]

Photon.SocketServer.Diagnostics.Counters.PerfCounterAttribute.PerfCounterAttribute ( string  name,
PerformanceCounterType  type,
PerformanceCounterInstanceLifetime  counterLifetime,
string  description = "",
string  categoryName = null 
)
inline

Initializes a new instance of the PerfCounterAttribute class.

Parameters
nameName of counter
typeType of system performance counter
counterLifetimeCounter instance lifetime. Takes precedence over PerfCounterCategoryAttribute.CategoryInstanceLifetime if specified.
descriptionCounter description
categoryNameTo which part counter applies: CounterCategory.Connection or CounterCategory.Server

Property Documentation

◆ CategoryName

string Photon.SocketServer.Diagnostics.Counters.PerfCounterAttribute.CategoryName
getset

To which part counter applies: CounterCategory.Connection or CounterCategory.Server

◆ CounterLifetime

PerformanceCounterInstanceLifetime? Photon.SocketServer.Diagnostics.Counters.PerfCounterAttribute.CounterLifetime
get

Counter instance lifetime. Takes precedence over PerfCounterCategoryAttribute.CategoryInstanceLifetime if specified.

◆ Description

string Photon.SocketServer.Diagnostics.Counters.PerfCounterAttribute.Description
get

Counter description

◆ Name

string Photon.SocketServer.Diagnostics.Counters.PerfCounterAttribute.Name
get

Name of counter

◆ Type

PerformanceCounterType Photon.SocketServer.Diagnostics.Counters.PerfCounterAttribute.Type
get

Type of system performance counter