Table of Contents

Constructor EnumAdapterRunner

Namespace
MVVrus.AspNetCore.ActiveSession.StdRunner
Assembly
MVVrus.AspNetCore.ActiveSession.dll

EnumAdapterRunner(IEnumerable<TItem>, RunnerId, IOptionsSnapshot<ActiveSessionOptions>, ILogger<EnumAdapterRunner<TItem>>?)

A constructor that creates EnumAdapterRunner instance. This constructor is used to create an instance by TypeRunnerFactory

[ActiveSessionConstructor(true)]
public EnumAdapterRunner(IEnumerable<TItem> Source, RunnerId RunnerId, IOptionsSnapshot<ActiveSessionOptions> Options, ILogger<EnumAdapterRunner<TItem>>? Logger)

Parameters

Source IEnumerable<TItem>
An enumerable for which the instance to be created will serve as an adapter.
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<EnumAdapterRunner<TItem>>
The ILogger instance used to write log messages from the instance to be created.

Exceptions

ArgumentNullException

EnumAdapterRunner(EnumAdapterParams<TItem>, RunnerId, IOptionsSnapshot<ActiveSessionOptions>, ILogger<EnumAdapterRunner<TItem>>?)

A constructor that creates EnumAdapterRunner instance. This constructor is used to create an instance by TypeRunnerFactory

[ActiveSessionConstructor(true)]
public EnumAdapterRunner(EnumAdapterParams<TItem> Params, RunnerId RunnerId, IOptionsSnapshot<ActiveSessionOptions> Options, ILogger<EnumAdapterRunner<TItem>>? Logger)

Parameters

Params EnumAdapterParams<TItem>

A structure that contains a refernce to the source enumerable and additional parameters.

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<EnumAdapterRunner<TItem>>
The ILogger instance used to write log messages from the instance to be created.

Exceptions

ArgumentNullException

EnumAdapterRunner(IEnumerable<TItem>, bool, CancellationTokenSource?, bool, int?, int?, bool, RunnerId, IOptionsSnapshot<ActiveSessionOptions>, ILogger?)

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

protected EnumAdapterRunner(IEnumerable<TItem> Source, bool PassSourceOnership, CancellationTokenSource? CompletionTokenSource, bool PassCtsOwnership, int? DefaultAdvance, int? EnumAheadLimit, bool StartInConstructor, RunnerId RunnerId, IOptionsSnapshot<ActiveSessionOptions> Options, ILogger? Logger)

Parameters

Source IEnumerable<TItem>

An enumerable for which the instance to be created will serve as an adapter.

PassSourceOnership bool

Flag showing that the instance to be created will be responsible for disposing the Source value passed to it.

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.

Exceptions

ArgumentNullException