{"id":102460,"date":"2019-04-30T07:00:00","date_gmt":"2019-04-30T14:00:00","guid":{"rendered":"http:\/\/devblogs.microsoft.com\/oldnewthing\/?p=102460"},"modified":"2019-06-06T17:46:44","modified_gmt":"2019-06-07T00:46:44","slug":"20190430-00","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20190430-00\/?p=102460","title":{"rendered":"Async-Async: Reducing the chattiness of cross-thread asynchronous operations"},"content":{"rendered":"

The Windows Runtime expresses the concept of asynchronous activity with the IAsync\u00adOperation<T><\/code> and IAsyncAction<\/code> interfaces. The former represents an operation that completes asynchronously with a result of type T<\/code>. The latter represents an operation that completes asynchronously with no result; you can think of it as IAsync\u00adOperation<void><\/code>. In fact, let’s just treat it as such for the purpose of this discussion.<\/p>\n

When you call a method like Do\u00adSomething\u00adAsync<\/code>, it returns an instance of the IAsync\u00adOperation<\/code> interface. All of the details of the IAsync\u00adOperation<\/code> interface are normally hidden from the developer by the language projection. If you are writing in C#, you see a Task<\/code>; in JavaScript, you get a Promise<\/code>. In C++\/WinRT and C++\/CX, you co_await<\/code> IAsync\u00adOperation<\/code>, and the co_await<\/code> machinery hides the details. In C++\/CX, you can also convert the IAsync\u00adOperation<\/code> into a concurrency::<\/code>task<\/code>, and then schedule your continuation that way.<\/p>\n

But today, we’re going to look at how things work under the covers.<\/p>\n

At the raw interface level, asynchronous operations work like this. In the diagrams, a solid arrow represents a call, and a dotted arrow represents the return from that call.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Client<\/th>\n\u00a0<\/th>\nServer<\/th>\n<\/tr>\n
Do\u00adSomething\u00adAsync()<\/code><\/td>\n\u2192<\/td>\nStart operation<\/td>\n<\/tr>\n
 <\/td>\n\u21e0<\/td>\nreturn IAsync\u00adOperation<\/code><\/td>\n<\/tr>\n
put_Completed(callback)<\/code><\/td>\n\u2192<\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n\u21e0<\/td>\nreturn<\/td>\n<\/tr>\n
Release()<\/code><\/td>\n\u2192<\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n\u21e0<\/td>\nrelease IAsync\u00adOperation<\/code><\/td>\n<\/tr>\n
… time passes …<\/td>\n<\/tr>\n
Operation completes<\/td>\n<\/tr>\n
 <\/td>\n\u2190<\/td>\ncallback.Invoke()<\/code><\/td>\n<\/tr>\n
get_Status()<\/code><\/td>\n\u2192<\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n\u21e0<\/td>\nreturn Completed (or Error)<\/td>\n<\/tr>\n
GetResults()<\/code><\/td>\n\u2192<\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n\u21e0<\/td>\nreturn results<\/td>\n<\/tr>\n
callback<\/code> returns<\/td>\n\u21e2<\/td>\nIAsync\u00adOperations<\/code> is destroyed<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

When the client calls the Do\u00adSomething\u00adAsync()<\/code> method, the call is sent to the server, which starts the operation and returns an IAsync\u00adOperation<\/code> which represents the operation in progress.<\/p>\n

The client calls the IAsync\u00adOperation::<\/code>put_<\/code>Completed<\/code> method to specify a callback that will be invoked when the operation is complete, thereby allowing the client to resume execution when the operation is complete. The server saves this callback and returns.<\/p>\n

The client releases the IAsync\u00adOperation<\/code>, since it no longer needs it. The operation itself keeps the IAsync\u00adOperation<\/code> alive.<\/p>\n

Time passes, and eventually the operation is complete.<\/p>\n

The server invokes the callback to let it know that the operation is complete. The client receives a reference to the original IAsync\u00adOperation<\/code> as part of the callback. The client can interrogate the IAsync\u00adOperation<\/code> to determine whether the operation was successful or not, and if successful, what the result was.<\/p>\n

Finally, when the callback returns, there are no more outstanding reference to the IAsync\u00adOperation<\/code>, so it destroys itself.<\/p>\n

You may have noticed that this is a very chatty<\/a> interface between the client and server. I mean, look at all those arrows!<\/p>\n

Enter Async-Async.<\/p>\n

Async-Async interposes layers on both the client and server which do local caching. The layer returns a fake async operation to the client and provides a fake client to the server.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Client<\/th>\n\u00a0<\/th>\nClient Layer<\/th>\n\u00a0<\/th>\nServer Layer<\/th>\n\u00a0<\/th>\nServer<\/th>\n<\/tr>\n
Do\u00adSomething\u00adAsync()<\/code><\/td>\n\u2192<\/td>\ncreate fake IAsyncOperation<\/code><\/td>\n\u00a0<\/td>\n<\/tr>\n
 <\/td>\n\u21e0<\/td>\nreturn fake IAsyncOperation<\/code><\/td>\n\u2192<\/td>\nfake client<\/td>\n\u2192<\/td>\nStart operation<\/td>\n<\/tr>\n
put_Completed(callback)<\/code><\/td>\n\u2192<\/td>\nsave in fake IAsyncOperation<\/code><\/td>\n\u00a0<\/td>\n <\/td>\n\u21e0<\/td>\nreturn IAsyncOperation<\/code><\/td>\n<\/tr>\n
 <\/td>\n\u21e0<\/td>\nreturn<\/td>\n\u00a0<\/td>\nput_Completed(private)<\/code><\/td>\n\u2192<\/td>\n<\/tr>\n
Release()<\/code><\/td>\n\u2192<\/td>\n <\/td>\n\u00a0<\/td>\n <\/td>\n\u21e0<\/td>\nreturn<\/td>\n<\/tr>\n
 <\/td>\n\u21e0<\/td>\nrelease fake IAsync\u00adOperation<\/code><\/td>\n\u00a0<\/td>\nRelease()<\/code><\/td>\n\u2192<\/td>\n<\/tr>\n
 <\/td>\n <\/td>\n <\/td>\n\u00a0<\/td>\n <\/td>\n\u21e0<\/td>\nrelease IAsync\u00adOperation<\/code><\/td>\n<\/tr>\n
… time passes …<\/td>\n<\/tr>\n
Operation completes<\/td>\n<\/tr>\n
 <\/td>\n <\/td>\n <\/td>\n\u00a0<\/td>\n <\/td>\n\u2190<\/td>\nprivate.Invoke()<\/code><\/td>\n<\/tr>\n
 <\/td>\n <\/td>\n <\/td>\n\u00a0<\/td>\nget_Status()<\/code><\/td>\n\u2192<\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n <\/td>\n <\/td>\n\u00a0<\/td>\n <\/td>\n\u21e0<\/td>\nreturn Completed (or Error)<\/td>\n<\/tr>\n
 <\/td>\n <\/td>\n <\/td>\n\u00a0<\/td>\nGetResults()<\/code><\/td>\n\u2192<\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n <\/td>\n <\/td>\n\u00a0<\/td>\n <\/td>\n\u21e0<\/td>\nreturn results<\/td>\n<\/tr>\n
 <\/td>\n <\/td>\n <\/td>\n\u21e0<\/td>\nreturn status and results<\/td>\n<\/tr>\n
 <\/td>\n <\/td>\ncache status and results<\/td>\n\u00a0<\/td>\n<\/tr>\n
 <\/td>\n\u2190<\/td>\ncallback.Invoke()<\/code><\/td>\n\u00a0<\/td>\nprivate<\/code> returns<\/td>\n\u21e2<\/td>\nIAsyncOperation<\/code> is destroyed<\/td>\n<\/tr>\n
get_Status()<\/code><\/td>\n\u2192<\/td>\n <\/td>\n\u00a0<\/td>\n<\/tr>\n
 <\/td>\n\u21e0<\/td>\nreturn cached status<\/td>\n\u00a0<\/td>\n<\/tr>\n
GetResults()<\/code><\/td>\n\u2192<\/td>\n <\/td>\n\u00a0<\/td>\n<\/tr>\n
 <\/td>\n\u21e0<\/td>\nreturn cached results<\/td>\n\u00a0<\/td>\n<\/tr>\n
callback<\/code> returns<\/td>\n\u21e2<\/td>\nfake IAsync\u00adOperation<\/code> is destroyed<\/td>\n\u00a0<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

With Async-Async, the client’s call to Do\u00adSomething\u00adAsync()<\/code> creates a fake IAsync\u00adOperation<\/code> on the client side. This fake IAsync\u00adOperation<\/code> makes a call out to the server to initiate the operation, but doesn’t wait for the server to respond to the request. Instead, the fake IAsync\u00adOperation<\/code> immediately returns to the client.<\/p>\n

As before, the client calls IAsync\u00adOperation::<\/code>put_<\/code>Completed<\/code> method to specify a callback that will be invoked when the operation is complete, thereby allowing the client to resume execution when the operation is complete. The fake IAsync\u00adOperation<\/code> saves this callback and returns.<\/p>\n

The client releases the fake IAsync\u00adOperation<\/code>, since it no longer needs it. The operation itself keeps the IAsync\u00adOperation<\/code> alive.<\/p>\n

Meanwhile, the request from the fake IAsync\u00adOperation<\/code> reaches the server, where a fake client is constructed. This fake client asks the real server to start the operation, and it registers its own private callback to be notified when the operation is complete, and then it releases the IAsync\u00adOperation<\/code>.<\/p>\n

Time passes, and eventually the operation is complete.<\/p>\n

The server invokes the callback to notify the fake client that the operation is complete. The fake client immediately retrieves the status and result, and transmits both to the fake IAsync\u00adOperation<\/code>, thereby completing the asynchronous call that was initiated by the fake IAsync\u00adOperation<\/code> at the start.<\/p>\n

The fake client then returns from its callback, and everything on the server side is now all done.<\/p>\n

Meanwhile, the fake IAsync\u00adOperation<\/code> has received the operation’s status and result and invokes the client’s callback. As before, the client calls the IAsync\u00adOperation::<\/code>get_<\/code>Status()<\/code> method to find out whether the operation was successful or not, and it calls the IAsync\u00adOperation::<\/code>Get\u00adResults()<\/code> method to obtain the results of the asynchronous operation from the fake IAsync\u00adOperation<\/code>. The client returns from its callback, and everything on the client side is now all done.<\/p>\n

This interface is much less chatty. There is only one call from the client to the server (to start the operation), and only one call from the server back to the client (to indicate the status and result of the operation). All the rest of the calls are local and therefore fast.<\/p>\n

From the client’s perspective, Async-Async takes asynchronous operations and makes them even more asynchronous: Not only does the operation itself run asynchronously, even the starting<\/i> of the operation takes place asynchronously. This gives control back to the client sooner, so it can do productive things like, say, running other ready tasks.<\/p>\n

Note that Async-Async comes into play only when the method call needs to be marshaled. If the client and server are on the same thread, then there is no need for Async-Async because the calls are all local already.<\/p>\n

Async-Async was introduced in Windows 10, and it is enabled for nearly all Windows-provided asynchronous operations. There are some methods that do not use Async-Async because they need to start synchronously; UI operations fall into this category.<\/p>\n

You can enable Async-Async for your own asynchronous operations by adding the [remote_async]<\/code> attribute<\/a> to your methods.<\/p>\n

runtimeclass Awesome\r\n{\r\n  [remote_async]<\/span>\r\n  Windows.Foundation.IAsyncAction BeAwesomeAsync();\r\n};\r\n<\/pre>\n
Although Async-Async is intended to be transparent to the client, there are some things to be aware of. We’ll look at those next time.<\/p>\n","protected":false},"excerpt":{"rendered":"
Setting up fakes on both sides.<\/p>\n","protected":false},"author":1069,"featured_media":111744,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[26],"class_list":["post-102460","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-oldnewthing","tag-other"],"acf":[],"blog_post_summary":"
Setting up fakes on both sides.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/102460","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/users\/1069"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/comments?post=102460"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/102460\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media\/111744"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media?parent=102460"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/categories?post=102460"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/tags?post=102460"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}