Class SchedulerPerformanceCounters

Represents performance counters retrieved from a scheduler.

Inheritance

System.Object

SchedulerPerformanceCounters

Implements

System.IEquatable<SchedulerPerformanceCounters>

Namespace: Reaqtive.Scheduler

Assembly: Reaqtive.Scheduler.dll

Syntax

public sealed class SchedulerPerformanceCounters : ValueType, IEquatable<SchedulerPerformanceCounters>

Properties

KernelTime

Gets the total time spent performing scheduler infrastructure work.

Declaration

public Duration KernelTime { get; }

Property Value

Type	Description
Duration

PausedTime

Gets the total time the scheduler was in a paused state.

Declaration

public TimeSpan PausedTime { get; }

Property Value

Type	Description
System.TimeSpan

TaskExecutionCount

Gets the total number of task executions that have been performed by the scheduler.

Declaration

public long TaskExecutionCount { get; }

Property Value

Type	Description
System.Int64

Remarks

This value represents the total number of tasks executions that have been performed, including the execution of timers, and repeated executions of the same tasks in case of recurring tasks. This number can be used as a proxy to the amount of work running on the scheduler, provided the distribution of the granularity of work is relatively uniform.

TimerTickCount

Gets the total number of timer ticks that have been invoked by the scheduler.

Declaration

public long TimerTickCount { get; }

Property Value

Type	Description
System.Int64

Remarks

This value represents the total number of expired timer tasks that were made runnable by the scheduler, including repeated expirations for periodic timer tasks. This number can be used as a proxy to the amount of time-based task execution activity running on the scheduler.

Uptime

Gets the total uptime of the scheduler.

Declaration

public TimeSpan Uptime { get; }

Property Value

Type	Description
System.TimeSpan

UserTime

Gets the total time spent on running user work.

Declaration

public Duration UserTime { get; }

Property Value

Type	Description
Duration

Methods

Add(SchedulerPerformanceCounters)

Returns a SchedulerPerformanceCounters whose value represents the sum of the specified counters and the current value.

Declaration

public SchedulerPerformanceCounters Add(SchedulerPerformanceCounters counters)

Parameters

Type	Name	Description
SchedulerPerformanceCounters	counters	The performance counter to add.

Returns

Type	Description
SchedulerPerformanceCounters	A performance counter object representing the sum of the given performance counters.

Equals(SchedulerPerformanceCounters)

Checks whether the current counters and the specified counters are equal.

Declaration

public bool Equals(SchedulerPerformanceCounters other)

Parameters

Type	Name	Description
SchedulerPerformanceCounters	other	The counters to check the current counters against for equality.

Returns

Type	Description
System.Boolean	true if this counters instance is equal to the specified counters instance; otherwise, false.

Equals(Object)

Checks whether the current object and the specified object are equal.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj	The object to check the current object against for equality.

Returns

Type	Description
System.Boolean	true if this object is equal to the specified object; otherwise, false.

GetHashCode()

Gets a hash code for the current object.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	A hash code for the current object.

Subtract(SchedulerPerformanceCounters)

Returns a SchedulerPerformanceCounters whose value represents the subtraction of the specified counters and the current value.

Declaration

public SchedulerPerformanceCounters Subtract(SchedulerPerformanceCounters counters)

Parameters

Type	Name	Description
SchedulerPerformanceCounters	counters	The performance counter to subtract.

Returns

Type	Description
SchedulerPerformanceCounters	A performance counter object representing the subtraciton of the given performance counters.

Operators

Addition(SchedulerPerformanceCounters, SchedulerPerformanceCounters)

Adds two performance counter instances using pairwise addition of counter values.

Declaration

public static SchedulerPerformanceCounters operator +(SchedulerPerformanceCounters left, SchedulerPerformanceCounters right)

Parameters

Type	Name	Description
SchedulerPerformanceCounters	left	The left performance counter to add.
SchedulerPerformanceCounters	right	The right performance counter to add.

Returns

Type	Description
SchedulerPerformanceCounters	A performance counter object representing the sum of the given performance counters.

Equality(SchedulerPerformanceCounters, SchedulerPerformanceCounters)

Checks whether the specified counters are equal.

Declaration

public static bool operator ==(SchedulerPerformanceCounters left, SchedulerPerformanceCounters right)

Parameters

Type	Name	Description
SchedulerPerformanceCounters	left	The first counter to compare.
SchedulerPerformanceCounters	right	The second counter to compare.

Returns

Type	Description
System.Boolean	true if the counters are equal; otherwise, false.

Inequality(SchedulerPerformanceCounters, SchedulerPerformanceCounters)

Checks whether the specified counters are not equal.

Declaration

public static bool operator !=(SchedulerPerformanceCounters left, SchedulerPerformanceCounters right)

Parameters

Type	Name	Description
SchedulerPerformanceCounters	left	The first counter to compare.
SchedulerPerformanceCounters	right	The second counter to compare.

Returns

Type	Description
System.Boolean	true if the counters are not equal; otherwise, false.

Subtraction(SchedulerPerformanceCounters, SchedulerPerformanceCounters)

Subtracts two performance counter instances using pairwise subtraction of counter values.

Declaration

public static SchedulerPerformanceCounters operator -(SchedulerPerformanceCounters left, SchedulerPerformanceCounters right)

Parameters

Type	Name	Description
SchedulerPerformanceCounters	left	The left performance counter to subtract.
SchedulerPerformanceCounters	right	The right performance counter to subtract.

Returns

Type	Description
SchedulerPerformanceCounters	A performance counter object representing the subtraction of the given performance counters.

Implements

System.IEquatable<>