Document System.IO.Pipelines.PipeOptions #3494
Conversation
carlossanlop
added
new-content
carlossanlop
requested review from
analogrelay,
halter73,
davidfowl and
jkotalik
|
Personally, I would use "async continuations" instead of "callbacks" everywhere "callbacks" are referenced. I would also make sure everywhere thresholds are referenced, we communicate that setting them to a negative value disables them. |
Co-Authored-By: Stephen Halter <halter73@gmail.com> Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>
| <param name="readerScheduler">The <see cref="T:System.IO.Pipelines.PipeScheduler" /> to be used to execute <see cref="T:System.IO.Pipelines.PipeReader" /> callbacks and async continuations.</param> | ||
| <param name="writerScheduler">The <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and async continuations.</param> | ||
| <param name="pauseWriterThreshold">The number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> before <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> starts blocking. A negative value prevents <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> from ever blocking, effectively making the number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> unlimited.</param> | ||
| <param name="resumeWriterThreshold">The number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> stops blocking.</param> |
There was a problem hiding this comment.
@halter73 you wrote:
Personally, I would use "async continuations" instead of "callbacks" everywhere "callbacks" are referenced. I would also make sure everywhere thresholds are referenced, we communicate that setting them to a negative value disables them.
But I'm not entirely sure how to explain it for resumeWriterThreshold. Would you mind helping here?
There was a problem hiding this comment.
This one is a little weird because technically you don't need to disable resumeWriterThreshold if you've already disabled the pauseWriterThreshold. And if the pauseWriterThreshold isn't disabled, it would be silly to disable the resumeWriterThreshold. So keeping this as-is and not mentioning what happens when you set the resumeWriterThreshold negative is probably fine.
|
@halter73 would you mind taking another quick look? I modified the places where callback was used and included continuations. |
carlossanlop
added
verify-build-before-merge
and removed
waiting-on-reviews
PR that introduced the System.IO.Pipelines namespace: dotnet/corefx#27007
PipeOptions code: corefx/src/System.IO.Pipelines/src/System/IO/Pipelines/PipeOptions.cs
Area owners: @davidfowl @jkotalik @halter73 @anurse