Class Delayer

Namespace

Garyon.Mechanisms

Assembly

Garyon.dll

Represents a delayer that keeps track of the next time moment that it can be unblocked, allowing awaiting the next unblock.

public sealed class Delayer

Inheritance

object

Delayer

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ComparisonExtensions.BeginCompare<T>(T, T)

IEnumeratorExtensions.GetEnumerator<TEnumerator, TValue>(TEnumerator)

MoreLinqExtensions.Apply<TSource>(TSource, Action<TSource>)

MoreLinqExtensions.Apply<TSource, TResult>(TSource, Func<TSource, TResult>)

SingleValueEnumeratorExtensions.EnumerateSingle<T>(T)

Properties

IsWaiting

Denotes whether the delayer has registered a task for awaiting the next unblock.

public bool IsWaiting { get; }

Property Value

bool

Methods

CancelUnblock()

Cancels the next unblock time, effectively unblocking the delayer and allowing any unblock time to be set.

public void CancelUnblock()

Remarks

If an active await task is present, it will be ignored but not cancelled. The task returned from WaitUnblock(CancellationToken) must have its cancellation token signal the cancellation manually in order to avoid waiting for the original unblock time.

ExtendNextUnblock(DateTime)

Sets the next unblock to the specified DateTime.

public void ExtendNextUnblock(DateTime next)

Parameters

next DateTime

The time to set the next unblock time to.

Remarks

If the next unblock is already set to a later time, this method does not overwrite the next unblock time.

SetFutureUnblock(TimeSpan)

Sets the next unblock time to Now plus the specified TimeSpan.

public void SetFutureUnblock(TimeSpan span)

Parameters

span TimeSpan

The timespan representing the offset from the current time.

Remarks

If the next unblock is already set to a later time, this method does not overwrite the next unblock time.

WaitUnblock(CancellationToken)

Waits until the unblock time is reached. This allows consecutive unblock time delays until the instance is considered unblocked, via methods like ExtendNextUnblock(DateTime).

public Task WaitUnblock(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

A CancellationToken allowing to cancel the awaiting task.

Returns

Task

A task representing the awaiting of the next unblock time.

Remarks

The cancellationToken must be manually cancelled if CancelUnblock() is called while awaiting the task.