Constructor TimeSeriesRunner

Namespace

MVVrus.AspNetCore.ActiveSession.StdRunner

Assembly

MVVrus.AspNetCore.ActiveSession.dll

TimeSeriesRunner((Func<TResult>, TimeSpan), RunnerId, IOptionsSnapshot<ActiveSessionOptions>, ILogger<TimeSeriesRunner<TResult>>?)

A constructor that creates TimeSeriesRunner instance. This constructor is used to create an instance via TypeRunnerFactory.

Creates a runner producing an unlimited series of measurements.

[ActiveSessionConstructor(true)]
public TimeSeriesRunner((Func<TResult>, TimeSpan) SeriesParam, RunnerId RunnerId, IOptionsSnapshot<ActiveSessionOptions> Options, ILogger<TimeSeriesRunner<TResult>>? Logger)

Parameters

SeriesParam (Func<TResult>, TimeSpan)

A pair of values. The first value is a delegate that returns a result of a measurement. The second value is a requested interval between measurements.

RunnerId RunnerId

The identifier to be assigned to the instance to be created.

Options IOptionsSnapshot<ActiveSessionOptions>

Presents access to a configuration object via the options pattern

Logger ILogger<TimeSeriesRunner<TResult>>

The ILogger instance used to write log messages from the instance to be created.

TimeSeriesRunner((Func<TResult>, TimeSpan, int), RunnerId, IOptionsSnapshot<ActiveSessionOptions>, ILogger<TimeSeriesRunner<TResult>>?)

A constructor that creates TimeSeriesRunner instance. This constructor is used to create an instance via TypeRunnerFactory.

Creates a runner producing a finite series of measurements.

[ActiveSessionConstructor(true)]
public TimeSeriesRunner((Func<TResult>, TimeSpan, int) SeriesParam, RunnerId RunnerId, IOptionsSnapshot<ActiveSessionOptions> Options, ILogger<TimeSeriesRunner<TResult>>? Logger)

Parameters

SeriesParam (Func<TResult>, TimeSpan, int)

A group of three values. The first value is a delegate that returns a result of a measurement. The second value is a requested interval between measurements. The third value is a maximum number of measurements to be performed.

RunnerId RunnerId

The identifier to be assigned to the instance to be created.

Options IOptionsSnapshot<ActiveSessionOptions>

Presents access to a configuration object via the options pattern

Logger ILogger<TimeSeriesRunner<TResult>>

The ILogger instance used to write log messages from the instance to be created.

TimeSeriesRunner(TimeSeriesParams<TResult>, RunnerId, IOptionsSnapshot<ActiveSessionOptions>, ILogger<TimeSeriesRunner<TResult>>?)

A constructor that creates TimeSeriesRunner instance. This constructor is used to create an instance via TypeRunnerFactory.

[ActiveSessionConstructor(true)]
public TimeSeriesRunner(TimeSeriesParams<TResult> SeriesParam, RunnerId RunnerId, IOptionsSnapshot<ActiveSessionOptions> Options, ILogger<TimeSeriesRunner<TResult>>? Logger)

Parameters

SeriesParam TimeSeriesParams<TResult>

A structure that contains parameters used for creation of the instance. Fields of the structure contains the same values as the paramemters of the protected constructor with the same names.

RunnerId RunnerId

The identifier to be assigned to the instance to be created.

Options IOptionsSnapshot<ActiveSessionOptions>

Presents access to a configuration object via the options pattern

Logger ILogger<TimeSeriesRunner<TResult>>

The ILogger instance used to write log messages from the instance to be created.

TimeSeriesRunner(Func<TResult>, TimeSpan, int?, CancellationTokenSource?, bool, int?, int?, bool, RunnerId, IOptionsSnapshot<ActiveSessionOptions>, ILogger?)

A constructor that creates TimeSeriesRunner instance. This constructor has protected access level and is intended for use in other constructors of this and descendent classes.

protected TimeSeriesRunner(Func<TResult> Gauge, TimeSpan Interval, int? Count, CancellationTokenSource? CompletionTokenSource, bool PassCtsOwnership, int? DefaultAdvance, int? EnumAheadLimit, bool StartInConstructor, RunnerId RunnerId, IOptionsSnapshot<ActiveSessionOptions> Options, ILogger? Logger)

Parameters

Gauge Func<TResult>

A delegate that returns a result of a measurement.

Interval TimeSpan

Requested interval between measurements.

Count int?

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

CompletionTokenSource CancellationTokenSource

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.

PassCtsOwnership bool

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

DefaultAdvance int?

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

EnumAheadLimit int?

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

StartInConstructor bool

Set to true to start background processing in the constructor.

RunnerId RunnerId

The identifier to be assigned to the instance to be created.

Options IOptionsSnapshot<ActiveSessionOptions>

Presents access to a configuration object via the options pattern

Logger ILogger

The ILogger instance used to write log messages from the instance to be created.