Constructor AsyncEnumAdapterParams

Namespace

MVVrus.AspNetCore.ActiveSession.StdRunner

Assembly

MVVrus.AspNetCore.ActiveSession.dll

AsyncEnumAdapterParams(IAsyncEnumerable<TItem>, int?, CancellationTokenSource?, int?, bool, bool, bool)

Class containg parameters that are to be passed to the AsyncEnumAdapterRunner class constructor while creating it via IActiveSession.CreateRunner method.

public AsyncEnumAdapterParams(IAsyncEnumerable<TItem> Source, int? DefaultAdvance = null, CancellationTokenSource? CompletionTokenSource = null, int? EnumAheadLimit = null, bool PassSourceOnership = true, bool PassCtsOwnership = true, bool StartInConstructor = false)

Parameters

Source IAsyncEnumerable<TItem>

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

DefaultAdvance int?

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

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.

EnumAheadLimit int?

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

PassSourceOnership bool

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

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.

StartInConstructor bool

Set to true to start background processing in the constructor.