{"id":110857,"date":"2025-02-12T07:00:00","date_gmt":"2025-02-12T15:00:00","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/oldnewthing\/?p=110857"},"modified":"2025-02-12T13:51:36","modified_gmt":"2025-02-12T21:51:36","slug":"20250212-00","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20250212-00\/?p=110857","title":{"rendered":"Async-Async revisited: What about cancellation?"},"content":{"rendered":"

We learned some time ago about Async-Async<\/a>, a feature that reduces the chattiness of cross-thread asynchronous operations. One thing we didn’t cover in the diagram is cancellation. How does cancellation work in Async-Async?<\/p>\n

Recall that Async-Async works by creating two helper objects, one on the client side that pretends to be the server, and one on the server side that pretends to be the client. When the client initiates an asynchronous operation on the server, it receives an IAsyncOperation<\/code> object immediately: This object is the client side helper. That client side helper asynchronously contacts the server-side helper object, which itself initiates the actual asynchronous operation. This call is held pending until the actual asynchronous operation completes, at which point the cross-thread call is completed with the operation results.<\/p>\n

What happens when the operation is cancelled depends on when you cancel it.<\/p>\n

One possibility is that you manage to cancel the operation even before the client side helper can submit the call to the server.<\/p>\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\u00a0<\/td>\n <\/td>\n <\/td>\n <\/td>\n<\/tr>\n
put_Completed(callback)<\/code><\/td>\n\u2192<\/td>\nsave in fake IAsyncOperation<\/code><\/td>\n\u00a0<\/td>\n <\/td>\n <\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n\u21e0<\/td>\nreturn<\/td>\n\u00a0<\/td>\n <\/td>\n <\/td>\n <\/td>\n<\/tr>\n
Cancel()<\/code><\/td>\n\u2192<\/td>\n <\/td>\n\u00a0<\/td>\n <\/td>\n <\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n\u2190<\/td>\ncallback.Invoke()<\/code><\/td>\n\u00a0<\/td>\n <\/td>\n <\/td>\n <\/td>\n<\/tr>\n
get_Status()<\/code><\/td>\n\u2192<\/td>\n <\/td>\n\u00a0<\/td>\n <\/td>\n <\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n\u21e0<\/td>\nreturn Cancelled<\/td>\n\u00a0<\/td>\n <\/td>\n <\/td>\n <\/td>\n<\/tr>\n
GetResults()<\/code><\/td>\n\u2192<\/td>\n <\/td>\n\u00a0<\/td>\n <\/td>\n <\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n\u21e0<\/td>\nfail with ERROR_CANCELLED<\/code><\/td>\n\u00a0<\/td>\n <\/td>\n <\/td>\n <\/td>\n<\/tr>\n
callback<\/code> returns<\/td>\n\u21e2<\/td>\n <\/td>\n\u00a0<\/td>\n <\/td>\n <\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n\u21e0<\/td>\nCancel()<\/code> returns<\/td>\n\u00a0<\/td>\n <\/td>\n <\/td>\n <\/td>\n<\/tr>\n
Release()<\/code><\/td>\n\u2192<\/td>\n <\/td>\n\u00a0<\/td>\n <\/td>\n <\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n\u21e0<\/td>\ndestroy fake IAsync\u00adOperation<\/code><\/td>\n\u00a0<\/td>\n <\/td>\n <\/td>\n <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

In the case that the operation is cancelled by the client before any call goes out to the server, the client-side fake IAsync\u00adOperation<\/code> just acts like a regular cancelled operation: It calls the callback to report that the operation was cancelled, and if anybody asks about the status or results of the operation, it says “It’s cancelled.”<\/p>\n

Another case is that the client layer has already initiated the operation on the server side. In that case, the client layer cancels the pending request, but it doesn’t wait for an answer from the server. It just reports the cancellation to the client right away and lets the server cancel the underlying operation in due course.<\/p>\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 <\/td>\n<\/tr>\n
 <\/td>\n <\/td>\n <\/td>\n\u00a0<\/td>\nRelease()<\/code><\/td>\n\u2192<\/td>\n <\/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
Cancel()<\/code><\/td>\n\u2192<\/td>\ncancel pending call<\/td>\n\u2192<\/td>\n <\/td>\n <\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n\u2190<\/td>\ncallback.Invoke()<\/code><\/td>\n\u00a0<\/td>\ncancellation received<\/td>\n <\/td>\n <\/td>\n<\/tr>\n
get_Status()<\/code><\/td>\n\u2192<\/td>\n <\/td>\n\u00a0<\/td>\nCancel()<\/code><\/td>\n\u2192<\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n\u21e0<\/td>\nreturn Cancelled<\/td>\n\u00a0<\/td>\n <\/td>\n\u2190<\/td>\nprivate.Invoke()<\/code><\/td>\n<\/tr>\n
GetResults()<\/code><\/td>\n\u2192<\/td>\n <\/td>\n\u00a0<\/td>\nRelease()<\/code><\/td>\n\u2192<\/td>\nIAsyncOperation<\/code> is destroyed<\/td>\n<\/tr>\n
 <\/td>\n\u21e0<\/td>\nfail with ERROR_CANCELLED<\/code><\/td>\n\u00a0<\/td>\n <\/td>\n\u21e0<\/td>\nreturn<\/td>\n<\/tr>\n
callback<\/code> returns<\/td>\n\u21e2<\/td>\n <\/td>\n\u21e0<\/td>\ncancellation completes<\/td>\n <\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n\u21e0<\/td>\nCancel()<\/code> returns<\/td>\n\u00a0<\/td>\n <\/td>\n <\/td>\n <\/td>\n<\/tr>\n
Release()<\/code><\/td>\n\u2192<\/td>\n <\/td>\n\u00a0<\/td>\n <\/td>\n <\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n\u21e0<\/td>\ndestroy fake IAsync\u00adOperation<\/code><\/td>\n\u00a0<\/td>\n <\/td>\n <\/td>\n <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

In the case of a cancellation that takes place after the operation has already been submitted to the server, the client cancels the pending call, which the server layer interprets as a request to cancel the server-side operation.<\/p>\n

Yet another case is that the server-side operation has completed before the client issues the cancellation. In that case, when the client layer cancels the pending request, it is told “What are you talking about? It’s alredy done!” The client then apologizes and carries on.<\/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
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 <\/td>\n<\/tr>\n
 <\/td>\n <\/td>\n <\/td>\n\u00a0<\/td>\nRelease()<\/code><\/td>\n\u2192<\/td>\n <\/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
Cancel()<\/code><\/td>\n\u2192<\/td>\ncancel pending call<\/td>\n\u2192<\/td>\ncancellation received<\/td>\n <\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n\u2190<\/td>\ncallback.Invoke()<\/code><\/td>\n\u2190<\/td>\nCancel()<\/code><\/td>\n\u2192<\/td>\n(nop – already completed)<\/td>\n<\/tr>\n
get_Status()<\/code><\/td>\n\u2192<\/td>\n <\/td>\n\u00a0<\/td>\n <\/td>\n\u21e0<\/td>\nreturn<\/td>\n<\/tr>\n
 <\/td>\n\u21e0<\/td>\nreturn Cancelled<\/td>\n\u21e0<\/td>\ncancellation completes<\/td>\n <\/td>\n <\/td>\n<\/tr>\n
GetResults()<\/code><\/td>\n\u2192<\/td>\n <\/td>\n\u00a0<\/td>\nGetResults()<\/code><\/td>\n\u2192<\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n\u21e0<\/td>\nfail with ERROR_CANCELLED<\/code><\/td>\n\u00a0<\/td>\n <\/td>\n\u21e0<\/td>\nreturn results<\/td>\n<\/tr>\n
callback<\/code> returns<\/td>\n\u21e2<\/td>\n <\/td>\n\u00a0<\/td>\ntry to return status and results<\/td>\n<\/tr>\n
 <\/td>\n\u21e0<\/td>\nCancel()<\/code> returns<\/td>\n\u00a0<\/td>\n(nop – already cancelled)<\/td>\n<\/tr>\n
Release()<\/code><\/td>\n\u2192<\/td>\n <\/td>\n\u00a0<\/td>\nprivate<\/tt> returns<\/td>\n\u21e2<\/td>\nIAsyncOperation<\/code> is destroyed<\/td>\n<\/tr>\n
 <\/td>\n\u21e0<\/td>\ndestroy fake IAsync\u00adOperation<\/code><\/td>\n\u00a0<\/td>\n <\/td>\n <\/td>\n <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

This behavior does not require any changes to the client or server. The fake operations introduced at the client and server behave just like a normal client and server. But if you are paying close attention, you may be able to observe some differences.<\/p>\n

One potentially observable behavior change is that when the client cancels the operation quickly, the server-side operation might never have started. If you’re correlating logs on the client and server side, you might see more client operations than server operations.<\/p>\n

Another potentially observable behavior change is that the server may appear to receive cancellations “late” because the client’s Cancel<\/code> call returns immediately without waiting for the server-side cancellation to finish.<\/p>\n

Yet another potentially observable behavior change is that if the server receives the cancellation after it has completed the operation, the server’s logs will say that the operation ran successfully to completion, but the client’s logs will say that it cancelled the operation and received a Canceled<\/code> status.<\/p>\n

Similarly, if the server receives the cancellation request and decides to complete the operation with Completed<\/code> rather than cancelling, the client will still see Canceled<\/code>.<\/p>\n

Async-Async virtualizes out both sides of an asynchronous operation, improving overall throughput and reducing chattiness within the contract of the behavior of asynchronous operations, but it can introduce observable effects if you rely on behavior outside the strict bounds of the contract.<\/p>\n","protected":false},"excerpt":{"rendered":"

Even the cancellation is async.<\/p>\n","protected":false},"author":1069,"featured_media":111744,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[25],"class_list":["post-110857","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-oldnewthing","tag-code"],"acf":[],"blog_post_summary":"

Even the cancellation is async.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/110857","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=110857"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/110857\/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=110857"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/categories?post=110857"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/tags?post=110857"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}