When should TaskCompletionSource be used?

by

I mostly use it when only an event based API is available (for example Windows Phone 8 sockets):

public Task<Args> SomeApiWrapper()
{
    TaskCompletionSource<Args> tcs = new TaskCompletionSource<Args>(); 

    var obj = new SomeApi();

    // will get raised, when the work is done
    obj.Done += (args) => 
    {
        // this will notify the caller 
        // of the SomeApiWrapper that 
        // the task just completed
        tcs.SetResult(args);
    }

    // start the work
    obj.Do();

    return tcs.Task;
}

So it’s especially useful when used together with the C#5 async keyword.

More Related Contents:

  1. Simplest way to do a fire and forget method in c# 4.0
  2. Asynchronously wait for Task to complete with timeout
  3. How to flatten tree via LINQ?
  4. Running multiple async tasks and waiting for them all to complete
  5. How to abort a Task like aborting a Thread (Thread.Abort method)?
  6. StaTaskScheduler and STA thread message pumping
  7. Regarding usage of Task.Start() , Task.Run() and Task.Factory.StartNew()
  8. Covariance and IList
  9. How to use non-thread-safe async/await APIs and patterns with ASP.NET Web API?
  10. Multiple Parallel.ForEach loops in .Net
  11. How to put a task to sleep (or delay) in C# 4.0?
  12. Create a completed Task
  13. Waiting for async/await inside a task
  14. What does MaxDegreeOfParallelism do?
  15. Is it possible to run a .NET 4.5 app on XP?
  16. Revisiting Task.ConfigureAwait(continueOnCapturedContext: false)
  17. If my interface must return Task what is the best way to have a no-operation implementation?
  18. Read Big TXT File, Out of Memory Exception
  19. multiple awaits vs Task.WaitAll – equivalent?
  20. Parallel.For(): Update variable outside of loop
  21. Can .NET Task instances go out of scope during run?
  22. Executing tasks in parallel
  23. Difference between returning and awaiting a Task in an async method [duplicate]
  24. Use Task.Run() in synchronous method to avoid deadlock waiting on async method?
  25. A pattern for self-cancelling and restarting task
  26. How to correctly write Parallel.For with async methods
  27. Using CancellationToken for timeout in Task.Run does not work [duplicate]
  28. Converting async/await to Task.ContinueWith
  29. What is wrong with ToLowerInvariant()?
  30. Why is TaskScheduler.Current the default TaskScheduler?

Leave a Comment