Add clarification to AnonymousPipeClientStream that async is not supported on Windows #7723
Conversation
|
Tagging subscribers to this area: @dotnet/area-system-io Issue DetailsSummaryThis came up recently in a project of mine: daveaglick/MsBuildPipeLogger#4. It appears that on Windows platforms "asynchronous (overlapped) read and write operations are not supported by anonymous pipes" (from https://docs.microsoft.com/en-us/windows/win32/ipc/anonymous-pipe-operations). This limitation was also encountered by a developer and filed in the dotnet/runtime repository: dotnet/runtime#23638. I'm suggesting some slight language changes that make this behavior clearer in the .NET docs for
|
|
Docs Build status updates of commit 7c54f3c: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
| @@ -34,7 +34,7 @@ | |||
| </Base> | |||
| <Interfaces /> | |||
| <Docs> | |||
| <summary>Exposes the client side of an anonymous pipe stream, which supports both synchronous and asynchronous read and write operations.</summary> | |||
| <summary>Exposes the client side of an anonymous pipe stream, which supports both synchronous and asynchronous (on non-Windows platforms) read and write operations.</summary> | |||
There was a problem hiding this comment.
This is statement can be confusing to the end users, as AnonymousPipeClientStream derives from Stream and it offers ReadAsync and WriteAsync methods. These methods internally schedule sync work to thread pool and work fine, but without cancellation support.
I think that we should rather say that cancellation is not supported on Windows. @daveaglick what do you think?
There was a problem hiding this comment.
Yeah, I think you're right - it's confusing as I initially wrote it. The fact that the underlying pipe is still synchronous does seem like an implementation detail that's not super important in these docs. I'll update with language that makes it clear its only cancellation that's not supported.
There was a problem hiding this comment.
Updated this and ended up adding more details to (rather than remove) the remark further down. How does it look now?
|
Docs Build status updates of commit f3becb1: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
Summary
This came up recently in a project of mine: daveaglick/MsBuildPipeLogger#4. It appears that on Windows platforms "asynchronous (overlapped) read and write operations are not supported by anonymous pipes" (from https://docs.microsoft.com/en-us/windows/win32/ipc/anonymous-pipe-operations). This limitation was also encountered by a developer and filed in the dotnet/runtime repository: dotnet/runtime#23638.
I'm suggesting some slight language changes that make this behavior clearer in the .NET docs for
AnonymousPipeClientStream. It's possible that similar changes may be needed forAnonymousPipeServerStreamdocs as well. It's also possible that I've misunderstood the discussions in the linked issues (I'm certainly not an expert on pipes or the Win32 APIs) and more clarification or specifics are needed, but hopefully this gets the ball rolling.