TaskCompletionSource : When to use SetResult() versus TrySetResult(), etc

async-await, asynchronous, c#, c#-5.0, task-parallel-library

Solution

I suspect the point is that if there's only one thing which will be setting the result, just call `SetResult` etc. If you end up calling `SetResult` twice, that indicates a bug. (Likewise if the `TaskCompletionSource` has been disposed.)

If you've got several threads which could all be trying to set the result at the same time (e.g. it's there to indicate the first result out of several parallel web service calls) then use `TrySetResult`, as it's entirely reasonable for multiple threads to "try" to set the result, unaware of whether another thread has already set it.

I've not seen any official guidance on it, but that would make sense.

Problem

I'm trying to wrap my head around the TPL, the new `async` / `await` features in C# 5, and the mysteries of `TaskCompletionSource`. One thing that isn't clear to me is when to use `SetResult`, `SetException`, and `SetCancel` versus `TrySetResult`, `TrySetException` and `TrySetCancel`. This is what MSDN has to say: This operation will return false if the Task is already in one of the three final states: RanToCompletion, Faulted, or Canceled. This method also returns false if the underlying Task has already been disposed. Ok, I get that, but it doesn't really offer any guidance on when or why to use one over the other. So, what's the deal?

Original source