Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to get a Task that uses SynchronizationContext? And how are SynchronizationContext used anyway?

I am still learning the whole Task-concept and TPL. From my current understanding, the SynchronizationContext functions (if present) are used by await to dispatch the Task "somewhere". On the other hand, the functions in the Task class do not use the context, right?

So for example Task.Run(...) will always dispatch the action on an worker thread of the thread pool and ignore the SynchronizationContext.Current completely. await Foobar() would use the context to execute the generated task after the await?

If that is true, my question is: How can I obtain a Task, that actually runs an action but is dispatched using SynchronizationContext.Current.Send/Post ?

And can anyone recommend a good introduction into SynchronizationContext, especially when and how they are used by the rest of the framework? The MSDN seems to be very quiet about the class. The top Google hits (here and here) seem to be tailored to Windows Forms dispatching only. Stephen Cleary wrote an article which is nice to learn what contexts already exist and how they work, but I lack understanding of where and when they are actually used.

like image 222
Imi Avatar asked Jun 04 '13 11:06

Imi


People also ask

How does SynchronizationContext work?

Simply put, SynchronizationContext represents a location "where" code might be executed. Delegates that are passed to its Send or Post method will then be invoked in that location. ( Post is the non-blocking / asynchronous version of Send .) Every thread can have a SynchronizationContext instance associated with it.

What SynchronizationContext current?

SynchronizationContext is a representation of the current environment that our code is running in. That is, in an asynchronous program, when we delegate a unit of work to another thread, we capture the current environment and store it in an instance of SynchronizationContext and place it on Task object.

Does a Windows service have a synchronization context?

Bookmark this question. Show activity on this post. As far as I know, there isn't a synchronization context in a Windows Service application.

Does .NET core have SynchronizationContext?

Yesterday I was trying to show how to diagnose a deadlock situation when using blocking code over async.


2 Answers

How can I obtain a Task, that actually runs an action but is dispatched using SynchronizationContext.Current.Send/Post?

Use special task scheduler:

Task.Factory.StartNew(     () => {}, // this will use current synchronization context     CancellationToken.None,      TaskCreationOptions.None,      TaskScheduler.FromCurrentSynchronizationContext()); 

And can anyone recommend a good introduction into SynchronizationContext

Look at the article It's All About the SynchronizationContext by Stephen Cleary.

like image 131
Dennis Avatar answered Sep 28 '22 16:09

Dennis


As you're learning this, it's important to point out that Task as used by the TPL is quite different than Task as used by async/await, even though they're the same type. For example, TPL commonly uses parent/child tasks, but async/await does not.

TPL uses task schedulers to execute its tasks. As Dennis pointed out, TaskScheduler.FromCurrentSynchronizationContext will give you a task scheduler that uses Post on the current SynchronizationContext to execute its task.

async/await usually does not use task schedulers. I have an introductory async/await post on my blog that includes context information, and I also mention it briefly in my MSDN article (it's easy to overlook, though). Essentially, when an async method suspends at an await, by default it will capture the current SynchronizationContext (unless it is null, in which case it will capture the current TaskScheduler). When the async method resumes, it resumes executing in that context.

Dennis pointed out the TPL way of scheduling a task to the current SynchronizationContext, but in async/await world, that approach isn't necessary. Rather, you can explicitly schedule tasks to the thread pool via Task.Run:

async Task MyMethodAsync() {   // Whee, on a SynchronizationContext here!   await Task.Run(() => { }); // Ooo, on the thread pool!   // Back on the SynchronizationContext ...   //  ... automagically! } 

I wrote my SynchronizationContext article precisely because the MSDN docs were so lacking. I have a little more information on my blog, but all the important bits are in the MSDN article. Many types use AsyncOperation rather than SynchronizationContext directly; the best documentation for this is buried under the EAP docs (section "Threading and Context"). But I should also point out that EAP is effectively obsolete due to async/await, so I wouldn't write code using AsyncOperation (or SynchronizationContext) - unless I was actually writing my own SynchronizationContext.

like image 28
Stephen Cleary Avatar answered Sep 28 '22 15:09

Stephen Cleary