Struct Timeout

Helps to compute timeout for asynchronous operations.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: DotNext.Threading

Assembly: DotNext.dll

Syntax

public readonly struct Timeout

Constructors

Timeout(TimeSpan)

Constructs a new timeout control object.

Declaration

public Timeout(TimeSpan timeout)

Parameters

Type	Name	Description
TimeSpan	timeout	Max duration of operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	timeout is negative.

Timeout(TimeSpan, Timestamp)

Constructs a new timeout control object.

Declaration

public Timeout(TimeSpan timeout, Timestamp startedAt)

Parameters

Type	Name	Description
TimeSpan	timeout	Max duration of operation.
Timestamp	startedAt	The point in time when operation was started.

Exceptions

Type	Condition
ArgumentOutOfRangeException	timeout is negative; or startedAt is empty.

Timeout(TimeSpan, TimeProvider)

Constructs a new timeout control object.

Declaration

public Timeout(TimeSpan timeout, TimeProvider provider)

Parameters

Type	Name	Description
TimeSpan	timeout	Max duration of operation.
TimeProvider	provider	Time provider.

Exceptions

Type	Condition
ArgumentOutOfRangeException	timeout is negative.

Fields

InfiniteTicks

Represents a number of ticks in InfiniteTimeSpan.

Declaration

public const long InfiniteTicks = -10000

Field Value

Type	Description
long

MaxTimeoutParameterTicks

Represents maximum possible timeout value, in ticks, that can be passed to some methods such as Delay(TimeSpan) or CancelAfter(TimeSpan).

Declaration

public const long MaxTimeoutParameterTicks = 21474836470000

Field Value

Type	Description
long

Properties

Expired

Gets expired timeout.

Declaration

public static Timeout Expired { get; }

Property Value

Type	Description
Timeout

Infinite

Gets infinite timeout.

Declaration

public static Timeout Infinite { get; }

Property Value

Type	Description
Timeout

IsExpired

Indicates that timeout is occurred.

Declaration

public bool IsExpired { get; }

Property Value

Type	Description
bool

IsInfinite

Determines whether this timeout is infinite.

Declaration

public bool IsInfinite { get; }

Property Value

Type	Description
bool

Value

Gets value of this timeout.

Declaration

public TimeSpan Value { get; }

Property Value

Type	Description
TimeSpan

Methods

ThrowIfExpired()

Throws TimeoutException if timeout occurs.

Declaration

public void ThrowIfExpired()

Exceptions

Type	Condition
TimeoutException	Timeout occurred.

ThrowIfExpired(TimeProvider)

Throws TimeoutException if timeout occurs.

Declaration

public void ThrowIfExpired(TimeProvider provider)

Parameters

Type	Name	Description
TimeProvider	provider

Exceptions

Type	Condition
TimeoutException	Timeout occurred.

ThrowIfExpired(TimeProvider, out TimeSpan)

Throws TimeoutException if timeout occurs.

Declaration

public void ThrowIfExpired(TimeProvider provider, out TimeSpan remainingTime)

Parameters

Type	Name	Description
TimeProvider	provider	Time provider.
TimeSpan	remainingTime	The remaining time before timeout.

Exceptions

Type	Condition
TimeoutException	Timeout occurred.

ThrowIfExpired(out TimeSpan)

Throws TimeoutException if timeout occurs.

Declaration

public void ThrowIfExpired(out TimeSpan remainingTime)

Parameters

Type	Name	Description
TimeSpan	remainingTime	The remaining time before timeout.

Exceptions

Type	Condition
TimeoutException	Timeout occurred.

TryGetRemainingTime(TimeProvider, out TimeSpan)

Gets the remaining time.

Declaration

public bool TryGetRemainingTime(TimeProvider provider, out TimeSpan remainingTime)

Parameters

Type	Name	Description
TimeProvider	provider	Time provider.
TimeSpan	remainingTime	The remaining time before timeout.

Returns

Type	Description
bool	true if timeout hasn't happened yet; otherwise, false.

TryGetRemainingTime(out TimeSpan)

Gets the remaining time.

Declaration

public bool TryGetRemainingTime(out TimeSpan remainingTime)

Parameters

Type	Name	Description
TimeSpan	remainingTime	The remaining time before timeout.

Returns

Type	Description
bool	true if timeout hasn't happened yet; otherwise, false.

Validate(TimeSpan, string?)

Validates the timeout.

Declaration

public static void Validate(TimeSpan timeout, string? parameterName = null)

Parameters

Type	Name	Description
TimeSpan	timeout	The timeout value.
string	parameterName	The name of the timeout parameter passed by the caller.

Exceptions

Type	Condition
ArgumentOutOfRangeException	timeout is negative and not InfiniteTicks; or greater than MaxTimeoutParameterTicks.

Operators

operator false(in Timeout)

Indicates that timeout is not reached.

Declaration

public static bool operator false(in Timeout timeout)

Parameters

Type	Name	Description
Timeout	timeout	Timeout control object.

Returns

Type	Description
bool	false, if timeout is not reached; otherwise, false.

implicit operator TimeSpan(in Timeout)

Extracts original timeout value from this object.

Declaration

public static implicit operator TimeSpan(in Timeout timeout)

Parameters

Type	Name	Description
Timeout	timeout	Timeout control object.

Returns

Type	Description
TimeSpan	The original timeout value.

operator true(in Timeout)

Indicates that timeout is reached.

Declaration

public static bool operator true(in Timeout timeout)

Parameters

Type	Name	Description
Timeout	timeout	Timeout control object.

Returns

Type	Description
bool	true, if timeout is reached; otherwise, false.

Extension Methods

BasicExtensions.IsBetween<T, TLowerBound, TUpperBound>(T, TLowerBound, TUpperBound)

BasicExtensions.IsOneOf<T>(T, ReadOnlySpan<T>)

Collection.ToAsyncEnumerator<TEnumerator, T>(TEnumerator, CancellationToken)

Collection.ToClassicEnumerator<TEnumerator, T>(TEnumerator)

Enumerator.Skip<TEnumerator, T>(ref TEnumerator, int)

ExpressionBuilder.Const<T>(T)