TaskExtensions.WithCancellationAndTimeout Method

Extends a worker task with timeout and Cancellation

Namespace:  TwinCAT.Ads
Assembly:  TwinCAT.Ads.Abstractions (in TwinCAT.Ads.Abstractions.dll) Version: 6.0.328+39e3229

Syntax

C#

public static Task<AdsErrorCode> WithCancellationAndTimeout(
    this Task<AdsErrorCode> worker,
    TimeSpan timeout,
    CancellationToken cancellationToken
)

Parameters

worker

Type: System.Threading.Tasks.Task.AdsErrorCode.
The worker task.

timeout

Type: System.TimeSpan
The timeout.

cancellationToken

Type: System.Threading.CancellationToken
The cancellation token.

Return Value

Type: Task.AdsErrorCode.
Task<AdsErrorCode>.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Task.AdsErrorCode.. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception

Condition

OperationCanceledException

Reference

TaskExtensions Class

TwinCAT.Ads Namespace