Struct AsyncEnumAdapterParams<TItem>

Namespace: MVVrus.AspNetCore.ActiveSession.StdRunner

Assembly: MVVrus.AspNetCore.ActiveSession.dll

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

public record struct AsyncEnumAdapterParams<TItem> : IEquatable<AsyncEnumAdapterParams<TItem>>

Type Parameters

TItem: Type specializing the runner's IRunner<TResult> interface

Implements: IEquatable<AsyncEnumAdapterParams<TItem>>

Inherited Members: ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

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.

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.

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.

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

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

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

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