Constructor EnumerableRunnerBase

Namespace

MVVrus.AspNetCore.ActiveSession

Assembly

MVVrus.AspNetCore.ActiveSession.dll

EnumerableRunnerBase(CancellationTokenSource?, bool, RunnerId, ILogger?, IOptionsSnapshot<ActiveSessionOptions>, int?, int?)

Constructor for a runner object to be used in descendent classes

protected EnumerableRunnerBase(CancellationTokenSource? CompletionTokenSource, bool PassCtsOwnership, RunnerId RunnerId, ILogger? Logger, IOptionsSnapshot<ActiveSessionOptions> Options, int? DefaultAdvance = null, int? QueueSize = null)

Parameters

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.

RunnerId RunnerId

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

Logger ILogger

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

Options IOptionsSnapshot<ActiveSessionOptions>

Presents access to a configuration object via the options pattern

DefaultAdvance int?

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

QueueSize int?

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

Remarks

This constructor overload accepts default values for the DefaultAdvance and QueueSize parameters from the configuration ActiveSessionOptions object passed via Options using the options pattern

EnumerableRunnerBase(CancellationTokenSource?, bool, RunnerId, ILogger?, int, int)

Constructor for a runner object to be used in descendent classes

protected EnumerableRunnerBase(CancellationTokenSource? CompletionTokenSource, bool PassCtsOwnership, RunnerId RunnerId, ILogger? Logger, int DefaultAdvance, int QueueSize)

Parameters

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.

RunnerId RunnerId

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

Logger ILogger

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

DefaultAdvance int

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

QueueSize int

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

Remarks

This constructor overload does not accept any default values for the DefaultAdvance and QueueSize parameters