Class CounterTask

Namespace

LfrlAnvil.Async

Assembly

LfrlAnvil.Core.dll

An object that contains an underlying Task that gets completed once Count reaches the Limit.

public sealed class CounterTask : IDisposable

Inheritance

object

CounterTask

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.Memoize<T1, T2>(T1, Func<T1, IEnumerable<T2>>)

ObjectExtensions.ToRef<T>(T)

ObjectExtensions.VisitManyWithSelf<T>(T, Func<T, IEnumerable<T>>)

ObjectExtensions.VisitManyWithSelf<T>(T, Func<T, IEnumerable<T>>, Func<T, bool>)

ObjectExtensions.VisitMany<T>(T, Func<T, IEnumerable<T>>)

ObjectExtensions.VisitMany<T>(T, Func<T, IEnumerable<T>>, Func<T, bool>)

ObjectExtensions.VisitWithSelf<T>(T?, Func<T, T?>)

ObjectExtensions.VisitWithSelf<T>(T, Func<T, T>, Func<T, bool>)

ObjectExtensions.Visit<T>(T?, Func<T, T?>)

ObjectExtensions.Visit<T>(T, Func<T, T>, Func<T, bool>)

Constructors

CounterTask(int, int)

Creates a new CounterTask instance.

public CounterTask(int limit, int count = 0)

Parameters

limit int

An immutable value. Once Count reaches this value, then the underlying Task will get completed. Negative values will be replaced with 0.

count int

Initial count. Equal to 0 by default. If greater than or equal to limit, then the underlying Task wiil get completed immediately.

Properties

Count

Current count. When this reaches the Limit, then the Task will get completed.

public int Count { get; }

Property Value

int

Limit

Count limit. When Count reaches this value, then the Task will get completed.

public int Limit { get; }

Property Value

int

Task

Underlying task that gets completed once Count reached the Limit or when this CounterTask gets disposed, which will cancel it instead.

public Task Task { get; }

Property Value

Task

Methods

Add(int)

Increases the Count by the provided count. When Count reaches the Limit, then the Task gets completed.

public bool Add(int count)

Parameters

count int

Value to increase the Count by. Negative values will be treated as 0.

Returns

bool

true when the Task is already completed or when the Count reaches the Limit and Task gets completed because of that, otherwise false.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Remarks

If the Task isn't completed yet, then it will get cancelled instead.

Increment()

Increases the Count by 1. When Count reaches the Limit, then the Task gets completed.

public bool Increment()

Returns

bool

true when the Task is already completed or when the Count reaches the Limit and Task gets completed because of that, otherwise false.

Remarks

Equivalent to Add(int) with count equal to 1.