jason-c-daniels / jcd.tasks Goto Github PK

Request Summary

Add more TryWaitAsync overloads, to match TryWait

Proposed Resolution

Give a 1 to 1 parity in overloads and parameters.

Alternatives

Remove TryWaitAsync - I use it in the test apps, and it seems useful. That's why I want more of them. :-)

Additional context

APIs with parallel xAsync APIs should always offer the same overloads only varying by return type. (Task/Task)

Task Description

Find a better name for Cancel on BlockingTaskProcessor

Motivation

The name is misleading. It does more than just cancel task execution.

Additional Context

Appropriately named APIs are less likely to suffer misuse.

Task Description

BlockingTaskProcessor is completely lacking unit tests.

Motivation

This is to demonstrate it functions as expected.

Task Description

Find and use a robust implementation of LimitedConcurrencyTaskScheduler in BlockingTaskProcessor.

Motivation

Best practices adherence.

Additional Context

According to articles by the experts and (former?) implementers of Tasks within .Net there are some "bad practices" currently going on in BlockingTaskProcessor. One of these is BlockingTaskProcessor is not using a proper TaskScheduler in order to start the tasks being executed.

https://devblogs.microsoft.com/pfxteam/faq-on-task-start/
https://learn.microsoft.com/en-us/dotnet/api/system.threading.tasks.paralleloptions?view=net-7.0

Task Description

Write direct unit tests against TryEnqueueTask overloads.

Motivation

This ensures the method has adequate testing.

Task Description

Finish summary comments in TaskExtensions

Motivation

Summary comments are used to generate API documentation. Having these incomplete leaves the API documentation incomplete.