I want to trigger a task to run on a background thread. I don't want to wait on the tasks completion.
In .net 3.5 I would have done this:
ThreadPool.QueueUserWorkItem(d => { DoSomething(); });
In .net 4 the TPL is the suggested way. The common pattern I have seen recommended is:
Task.Factory.StartNew(() => { DoSomething(); });
However, the StartNew() method returns a Task object which implements IDisposable. This
seems to be overlooked by people who recommend this pattern. The MSDN documentation on the Task.Dispose() method says:
"Always call Dispose before you release your last reference to the Task."
You can't call dispose on a task until it is completed, so having the main thread wait and call dispose would defeat the point of doing on a background thread in the first place. There also doesn't seem to be any completed/finished event that could be used for cleanup.
The MSDN page on the Task class doesn't comment on this, and the book "Pro C#2010..." recommends the same pattern and makes no comment on task disposal.
I know if I just leave it the finalizer will catch it in the end, but is this going to come back and bite me when I'm doing lots of fire & forget tasks like this and the finalizer thread gets overwhelmed?
So my questions are:
Dispose() on the Task class in this case? And if so, why and are there risks/consequences?Task object that I've missed?
There is a discussion about this in the MSDN forums.
Stephen Toub, a member of the Microsoft pfx team has this to say:
Task.Dispose exists due to Task potentially wrapping an event handle used when waiting on the task to complete, in the event the waiting thread actually has to block (as opposed to spinning or potentially executing the task it's waiting on). If all you're doing is using continuations, that event handle will never be allocated
...
it's likely better to rely on finalization to take care of things.
Update (Oct 2012)
Stephen Toub has posted a blog titled Do I need to dispose of Tasks? which gives some more detail, and explains the improvements in .Net 4.5.
In summary: You don't need to dispose of Task objects 99% of the time.
There are two main reasons to dispose an object: to free up unmanaged resources in a timely, deterministic way, and to avoid the cost of running the object's finalizer. Neither of these apply to Task most of the time:
Task allocates the internal wait handle (the only unmanaged resource in the Task object) is when you explicitly use the IAsyncResult.AsyncWaitHandle of the Task, andTask object itself doesn't have a finalizer; the handle is itself wrapped in an object with a finalizer, so unless it's allocated, there's no finalizer to run.EndInvoke in WinForms when using BeginInvoke to run code on the UI thread). (2) Stephen Toub is quite well know as a regular speaker on effective use of PFX (e.g. on channel9.msdn.com), so if anyone can give good guidance then he's it. Note his second paragraph: there are times leaving things to the finaliser is better. - Richard
This is the same kind of issue as with the Thread class. It consumes 5 operating system handles but does not implement IDisposable. Good decision of the original designers, there are of course few reasonable ways to call the Dispose() method. You'd have to call Join() first.
The Task class adds one handle to this, an internal manual reset event. Which is the cheapest operating system resource there is. Of course, its Dispose() method can only release that one event handle, not the 5 handles that Thread consumes. Yeah, don't bother.
Do beware that you ought to be interested in the task's IsFaulted property. It's a fairly ugly topic, you can read more about it in this MSDN Library article. Once you deal with this properly, you should also have a good spot in your code to dispose the tasks.
Thread in most cases, it uses the ThreadPool. - svick
I'd love to see someone weigh on the technique shown in this post: Typesafe fire-and-forget asynchronous delegate invocation in C#
It looks like a simple extension method will handle all trivial cases of interacting with the tasks and be able to call dispose on it.
public static void FireAndForget<T>(this Action<T> act,T arg1)
{
var tsk = Task.Factory.StartNew( ()=> act(arg1),
TaskCreationOptions.LongRunning);
tsk.ContinueWith(cnt => cnt.Dispose());
}
Task instance returned by ContinueWith, but see the quote from Stephen Toub is the accepted answer: there is nothing to dispose if nothing performs a blocking wait on a task. - RichardTask disper = null; disper = tsk.ContinueWith(cnt => { cnt.Dispose(); disper.Dispose(); }); - Gideon Engelberth