Struct TimeSeriesParams<TResult>

Namespace: MVVrus.AspNetCore.ActiveSession.StdRunner

Assembly: MVVrus.AspNetCore.ActiveSession.dll

Class containg parametrs to pass to the TimeSeriesRunner<TResult> class constructor.

public record struct TimeSeriesParams<TResult> : IEquatable<TimeSeriesParams<TResult>>

Type Parameters

TResult: Type specializing the structure. Must be the same as a type parameter of the TimeSeriesRunner<TResult> class instance of which to be constructed.

Implements: IEquatable<TimeSeriesParams<TResult>>

Inherited Members: ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

TimeSeriesParams(Func<TResult>, TimeSpan, int?, int?, CancellationTokenSource?, int?, bool, bool): Class containg parametrs to pass to the TimeSeriesRunner<TResult> class constructor.

Properties

CompletionTokenSource: External source for a value of the CompletionToken property. If it is null (default value), a new CancellationTokenSource will be used as the source in the instance to be created.

Count: Maximum number of measurements in the series. May be null to produce a series with unlimited number of measurements.

DefaultAdvance: Default value for the first parameter (Advance) for GetRequiredAsync method of the instance to be created.

EnumAheadLimit: Maximum number of items fetched in background ahead of time in the instance to be created.

Gauge: A delegate that returns a result of a measurement.

Interval: Requested interval between measurements.

PassCtsOwnership: This value indicates will the instance to be created be responsible for disposing an external CompletionToken source if it was passed by CompletionTokenSource.

StartInConstructor: Set to true to start background processing in the constructor.