Class TaskHelper

Namespace

PuppeteerSharp.Helpers

Assembly

PuppeteerSharp.dll

Task helper.

public static class TaskHelper

Inheritance

object

TaskHelper

Properties

DefaultTimeout

Default timeout.

public static int DefaultTimeout { get; set; }

Property Value

int

Methods

WithTimeout(Task, Func<Task>, int, CancellationToken)

Cancels the task after milliseconds milliseconds.

public static Task WithTimeout(this Task task, Func<Task> timeoutAction, int milliseconds = 1000, CancellationToken cancellationToken = default)

Parameters

task Task

Task to wait for.

timeoutAction Func<Task>

Action to be executed on Timeout.

milliseconds int

Milliseconds timeout.

cancellationToken CancellationToken

Cancellation token.

Returns

Task

The task result.

WithTimeout(Task, Func<Task>, TimeSpan, CancellationToken)

Cancels the task after a given timeout period.

public static Task WithTimeout(this Task task, Func<Task> timeoutAction, TimeSpan timeout, CancellationToken cancellationToken)

Parameters

task Task

Task to wait for.

timeoutAction Func<Task>

Action to be executed on Timeout.

timeout TimeSpan

The timeout period.

cancellationToken CancellationToken

Cancellation token.

Returns

Task

The task result.

WithTimeout(Task, int?, Func<TimeSpan, Exception>, CancellationToken)

Cancels the task after milliseconds milliseconds.

public static Task WithTimeout(this Task task, int? milliseconds = null, Func<TimeSpan, Exception> exceptionFactory = null, CancellationToken cancellationToken = default)

Parameters

task Task

Task to wait for.

milliseconds int?

Milliseconds timeout.

exceptionFactory Func<TimeSpan, Exception>

Optional timeout exception factory.

cancellationToken CancellationToken

Cancellation token.

Returns

Task

The task result.

WithTimeout(Task, TimeSpan, Func<TimeSpan, Exception>, CancellationToken)

Cancels the task after a given timeout period.

public static Task WithTimeout(this Task task, TimeSpan timeout, Func<TimeSpan, Exception> exceptionFactory = null, CancellationToken cancellationToken = default)

Parameters

task Task

Task to wait for.

timeout TimeSpan

The timeout period.

exceptionFactory Func<TimeSpan, Exception>

Optional timeout exception factory.

cancellationToken CancellationToken

Cancellation token.

Returns

Task

The task result.

WithTimeout<T>(Task<T>, Action, int)

Cancels the task after milliseconds milliseconds.

public static Task<T> WithTimeout<T>(this Task<T> task, Action timeoutAction, int milliseconds = 1000)

Parameters

task Task<T>

Task to wait for.

timeoutAction Action

Action to be executed on Timeout.

milliseconds int

Milliseconds timeout.

Returns

Task<T>

The task result.

Type Parameters

T

Return type.

WithTimeout<T>(Task<T>, Action, TimeSpan)

Cancels the task after a given timeout period.

public static Task<T> WithTimeout<T>(this Task<T> task, Action timeoutAction, TimeSpan timeout)

Parameters

task Task<T>

Task to wait for.

timeoutAction Action

Action to be executed on Timeout.

timeout TimeSpan

The timeout period.

Returns

Task<T>

The task result.

Type Parameters

T

Return type.

WithTimeout<T>(Task<T>, int?, Func<TimeSpan, Exception>)

Cancels the task after milliseconds milliseconds.

public static Task<T> WithTimeout<T>(this Task<T> task, int? milliseconds = null, Func<TimeSpan, Exception> exceptionFactory = null)

Parameters

task Task<T>

Task to wait for.

milliseconds int?

Milliseconds timeout.

exceptionFactory Func<TimeSpan, Exception>

Optional timeout exception factory.

Returns

Task<T>

The task result.

Type Parameters

T

Task return type.

WithTimeout<T>(Task<T>, TimeSpan, Func<TimeSpan, Exception>)

Cancels the task after a given timeout period.

public static Task<T> WithTimeout<T>(this Task<T> task, TimeSpan timeout, Func<TimeSpan, Exception> exceptionFactory = null)

Parameters

task Task<T>

Task to wait for.

timeout TimeSpan

The timeout period.

exceptionFactory Func<TimeSpan, Exception>

Optional timeout exception factory.

Returns

Task<T>

The task result.

Type Parameters

T

Task return type.