Class LinkedTokenSourceFactory

Represents helper methods for working with linked cancellation tokens.

Inheritance

object

LinkedTokenSourceFactory

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: DotNext.Threading

Assembly: DotNext.Threading.dll

Syntax

public static class LinkedTokenSourceFactory

Methods

CausedBy(OperationCanceledException, LinkedCancellationTokenSource?, CancellationToken)

Determines whether the operation was canceled by the specified source.

Declaration

public static bool CausedBy(this OperationCanceledException e, LinkedCancellationTokenSource? source, CancellationToken token)

Parameters

Type	Name	Description
OperationCanceledException	e	The exception to analyze.
LinkedCancellationTokenSource	source	The linked token source.
CancellationToken	token	The token to check

Returns

Type	Description
bool	true indicates that the cancellation caused by source and CancellationOrigin is token ;or by token.

LinkTo(ref CancellationToken, ReadOnlySpan<CancellationToken>)

Links multiple cancellation tokens together.

Declaration

public static LinkedCancellationTokenSource? LinkTo(this ref CancellationToken first, ReadOnlySpan<CancellationToken> tokens)

Parameters

Type	Name	Description
CancellationToken	first	The first cancellation token. Can be modified by this method.
ReadOnlySpan<CancellationToken>	tokens	A list of cancellation tokens to link together.

Returns

Type	Description
LinkedCancellationTokenSource	The linked token source; or null if first or tokens are not cancelable.

LinkTo(ref CancellationToken, CancellationToken)

Links two cancellation tokens together.

Declaration

public static LinkedCancellationTokenSource? LinkTo(this ref CancellationToken first, CancellationToken second)

Parameters

Type	Name	Description
CancellationToken	first	The first cancellation token. Can be modified by this method.
CancellationToken	second	The second cancellation token.

Returns

Type	Description
LinkedCancellationTokenSource	The linked token source; or null if first or second is not cancelable.

LinkTo(ref CancellationToken, TimeSpan)

Links cancellation token with the timeout.

Declaration

public static CancellationTokenSource? LinkTo(this ref CancellationToken token, TimeSpan timeout)

Parameters

Type	Name	Description
CancellationToken	token	The first cancellation token. Can be modified by this method.
TimeSpan	timeout	The timeout to link.

Returns

Type	Description
CancellationTokenSource	The linked token source; or null if token is canceled or timeout is InfiniteTimeSpan.

LinkTo(ref CancellationToken, TimeSpan, CancellationToken)

Links two cancellation tokens with the given timeout.

Declaration

public static CancellationTokenSource? LinkTo(this ref CancellationToken first, TimeSpan timeout, CancellationToken second)

Parameters

Type	Name	Description
CancellationToken	first	The first cancellation token. Can be modified by this method.
TimeSpan	timeout	The timeout to link.
CancellationToken	second	The second cancellation token.

Returns

Type	Description
CancellationTokenSource	The linked token source; or null if not needed.