Skip to content

Commit 225052c

Browse files
carlossanlopcarlossanlop
authored
Document System.IO.Pipelines.PipeOptions (#3494)
* Document System.IO.Pipelines.PipeOptions * suggestions by halter73 and mairaw Co-Authored-By: Stephen Halter <[email protected]> Co-Authored-By: Maira Wenzel <[email protected]> * suggestions by halter73 * instance -> object
1 parent fa6e1d3 commit 225052c

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

‎xml/System.IO.Pipelines/PipeOptions.xml

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,14 @@
4545
<Parameter Name="useSynchronizationContext" Type="System.Boolean" />
4646
</Parameters>
4747
<Docs>
48-
<param name="pool">To be added.</param>
49-
<param name="readerScheduler">To be added.</param>
50-
<param name="writerScheduler">To be added.</param>
51-
<param name="pauseWriterThreshold">To be added.</param>
52-
<param name="resumeWriterThreshold">To be added.</param>
53-
<param name="minimumSegmentSize">To be added.</param>
54-
<param name="useSynchronizationContext">To be added.</param>
55-
<summary>Creates a new instance of <see cref="T:System.IO.Pipelines.PipeOptions" />.</summary>
48+
<param name="pool">The pool of memory blocks to be used for buffer management.</param>
49+
<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>
50+
<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>
51+
<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>
52+
<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>
53+
<param name="minimumSegmentSize">The minimum size of the segment requested from <paramref name="pool" />.</param>
54+
<param name="useSynchronizationContext"><see langword="true" /> if asynchronous continuations should be executed on the <see cref="T:System.Threading.SynchronizationContext" /> they were captured on; <see langword="false" /> otherwise. This takes precedence over the schedulers specified in <see cref="P:System.IO.Pipelines.PipeOptions.ReaderScheduler" /> and <see cref="P:System.IO.Pipelines.PipeOptions.WriterScheduler" />.</param>
55+
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.PipeOptions" /> class with the specified parameters.</summary>
5656
<remarks>To be added.</remarks>
5757
</Docs>
5858
</Member>
@@ -75,7 +75,7 @@
7575
</ReturnValue>
7676
<Docs>
7777
<summary>Gets the default instance of <see cref="T:System.IO.Pipelines.PipeOptions" />.</summary>
78-
<value>To be added.</value>
78+
<value>A <see cref="T:System.IO.Pipelines.PipeOptions" /> object initialized with default parameters.</value>
7979
<remarks>To be added.</remarks>
8080
</Docs>
8181
</Member>
@@ -97,8 +97,8 @@
9797
<ReturnType>System.Int32</ReturnType>
9898
</ReturnValue>
9999
<Docs>
100-
<summary>Gets the minimum size of the segment requested from <see cref="P:System.IO.Pipelines.PipeOptions.Pool" />.</summary>
101-
<value>To be added.</value>
100+
<summary>Gets the minimum size of the segment requested from the <see cref="P:System.IO.Pipelines.PipeOptions.Pool" />.</summary>
101+
<value>The minimum size of the segment requested from the <see cref="P:System.IO.Pipelines.PipeOptions.Pool" />.</value>
102102
<remarks>To be added.</remarks>
103103
</Docs>
104104
</Member>
@@ -120,8 +120,8 @@
120120
<ReturnType>System.Int64</ReturnType>
121121
</ReturnValue>
122122
<Docs>
123-
<summary>Gets the amount of bytes in <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> starts blocking.</summary>
124-
<value>To be added.</value>
123+
<summary>Gets 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)" /> starts blocking.</summary>
124+
<value>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)" /> starts blocking.</value>
125125
<remarks>To be added.</remarks>
126126
</Docs>
127127
</Member>
@@ -143,8 +143,8 @@
143143
<ReturnType>System.Buffers.MemoryPool&lt;System.Byte&gt;</ReturnType>
144144
</ReturnValue>
145145
<Docs>
146-
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> instances used for buffer management.</summary>
147-
<value>To be added.</value>
146+
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> object used for buffer management.</summary>
147+
<value>A pool of memory blocks used for buffer management.</value>
148148
<remarks>To be added.</remarks>
149149
</Docs>
150150
</Member>
@@ -166,8 +166,8 @@
166166
<ReturnType>System.IO.Pipelines.PipeScheduler</ReturnType>
167167
</ReturnValue>
168168
<Docs>
169-
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeReader" /> callbacks.</summary>
170-
<value>To be added.</value>
169+
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeReader" /> callbacks and async continuations.</summary>
170+
<value>A <see cref="T:System.IO.Pipelines.PipeScheduler" /> that is used to execute <see cref="T:System.IO.Pipelines.PipeReader" /> callbacks and async continuations.</value>
171171
<remarks>To be added.</remarks>
172172
</Docs>
173173
</Member>
@@ -189,8 +189,8 @@
189189
<ReturnType>System.Int64</ReturnType>
190190
</ReturnValue>
191191
<Docs>
192-
<summary>Gets amount of bytes in <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> stops blocking.</summary>
193-
<value>To be added.</value>
192+
<summary>Gets 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.</summary>
193+
<value>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.</value>
194194
<remarks>To be added.</remarks>
195195
</Docs>
196196
</Member>
@@ -212,8 +212,8 @@
212212
<ReturnType>System.Boolean</ReturnType>
213213
</ReturnValue>
214214
<Docs>
215-
<summary>Gets a value that determines if asynchronous callbacks should be executed on the <see cref="T:System.Threading.SynchronizationContext" /> they were captured on. This takes precedence over the schedulers specified in <see cref="P:System.IO.Pipelines.PipeOptions.ReaderScheduler" /> and <see cref="P:System.IO.Pipelines.PipeOptions.WriterScheduler" />.</summary>
216-
<value>To be added.</value>
215+
<summary>Gets a value that determines if asynchronous callbacks and continuations should be executed on the <see cref="T:System.Threading.SynchronizationContext" /> they were captured on. This takes precedence over the schedulers specified in <see cref="P:System.IO.Pipelines.PipeOptions.ReaderScheduler" /> and <see cref="P:System.IO.Pipelines.PipeOptions.WriterScheduler" />.</summary>
216+
<value><see langword="true" /> if asynchronous callbacks and continuations should be executed on the <see cref="T:System.Threading.SynchronizationContext" /> they were captured on; otherwise, <see langword="false" />.</value>
217217
<remarks>To be added.</remarks>
218218
</Docs>
219219
</Member>
@@ -235,8 +235,8 @@
235235
<ReturnType>System.IO.Pipelines.PipeScheduler</ReturnType>
236236
</ReturnValue>
237237
<Docs>
238-
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks.</summary>
239-
<value>To be added.</value>
238+
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and async continuations.</summary>
239+
<value>A <see cref="T:System.IO.Pipelines.PipeScheduler" /> object used to execute <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and async continuations.</value>
240240
<remarks>To be added.</remarks>
241241
</Docs>
242242
</Member>

0 commit comments

Comments
 (0)