Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 19 additions & 9 deletions xml/System.Net.Http/HttpContent.xml
Original file line number Diff line number Diff line change
Expand Up @@ -794,10 +794,15 @@ When the `disposing` parameter is `true`, this method releases all resources hel
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="0" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="cancellationToken">The cancellation token to cancel the operation.</param>
<summary>Serialize the HTTP content to a memory buffer as an asynchronous operation.</summary>
<returns>The task object representing the asynchronous operation.</returns>
<remarks>
<para>This operation will not block. The returned <see cref="T:System.Threading.Tasks.Task" /> object will complete after all of the content has been serialized to the memory buffer.</para>
<para>After content is serialized to a memory buffer, calls to one of the <see cref="M:System.Net.Http.HttpContent.CopyToAsync(System.IO.Stream)" /> methods will copy the content of the memory buffer to the target stream.</para>
</remarks>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<exception cref="T:System.ObjectDisposedException">The object has already been disposed.</exception>
</Docs>
</Member>
<Member MemberName="LoadIntoBufferAsync">
Expand All @@ -823,11 +828,16 @@ When the `disposing` parameter is `true`, this method releases all resources hel
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<param name="maxBufferSize">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="maxBufferSize">The maximum size, in bytes, of the buffer to use.</param>
<param name="cancellationToken">The cancellation token to cancel the operation.</param>
<summary>Serialize the HTTP content to a memory buffer as an asynchronous operation.</summary>
<returns>The task object representing the asynchronous operation.</returns>
<remarks>
<para>This operation will not block. The returned <see cref="T:System.Threading.Tasks.Task" /> object will complete after all of the content has been serialized to the memory buffer.</para>
<para>After content is serialized to a memory buffer, calls to one of the <see cref="M:System.Net.Http.HttpContent.CopyToAsync(System.IO.Stream)" /> methods will copy the content of the memory buffer to the target stream.</para>
</remarks>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<exception cref="T:System.ObjectDisposedException">The object has already been disposed.</exception>
</Docs>
</Member>
<Member MemberName="ReadAsByteArrayAsync">
Expand Down
4 changes: 2 additions & 2 deletions xml/System.Net.Http/SocketsHttpHandler.xml
Original file line number Diff line number Diff line change
Expand Up @@ -451,9 +451,9 @@ The default proxy is used only when <xref:System.Net.Http.SocketsHttpHandler.Use
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets a value that indicates whether additional HTTP/3 connections can be established to the same server.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>Enabling multiple connections to the same server explicitly goes against <see href="https://www.rfc-editor.org/rfc/rfc9114.html#section-3.3-4">RFC 9114 - HTTP/3</see>.</remarks>
</Docs>
</Member>
<Member MemberName="Expect100ContinueTimeout">
Expand Down
6 changes: 5 additions & 1 deletion xml/System.Net.Quic/QuicConnectionOptions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,11 @@ To use a different close error code, call <xref:System.Net.Quic.QuicConnection.C
<ReturnType>System.Action&lt;System.Net.Quic.QuicConnection,System.Net.Quic.QuicStreamCapacityChangedArgs&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>
<para>Optional callback that is invoked when new stream limit is released by the peer. Corresponds to receiving a MAX_STREAMS frame.</para>
<para>The callback values represent increments of stream limits, e.g.: current limit is 10 bidirectional streams, callback arguments notify 5 more additional bidirectional streams =&gt; 15 bidirectional streams can be opened in total at the moment.</para>
<para>The initial capacity is reported with the first invocation of the callback that might happen before the <see cref="T:System.Net.Quic.QuicConnection" /> instance is handed out via either <see cref="M:System.Net.Quic.QuicConnection.ConnectAsync(System.Net.Quic.QuicClientConnectionOptions,System.Threading.CancellationToken)" /> or <see cref="M:System.Net.Quic.QuicListener.AcceptConnectionAsync(System.Threading.CancellationToken)" />.</para>
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
36 changes: 18 additions & 18 deletions xml/System.Net.Quic/QuicStream.xml
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@
<Docs>
<summary>Represents a QUIC stream. <see cref="T:System.Net.Quic.QuicStream" /> can be <see cref="F:System.Net.Quic.QuicStreamType.Unidirectional">unidirectional</see>, that is, write-only for the opening side, or <see cref="F:System.Net.Quic.QuicStreamType.Bidirectional">bidirectional</see>, which allows both sides to write.</summary>
<remarks>
<see cref="T:System.Net.Quic.QuicStream" /> can be used in a same way as any other <see cref="T:System.IO.Stream" />.
Apart from a stream API, <see cref="T:System.Net.Quic.QuicStream" /> also exposes QUIC-specific features:
<see cref="T:System.Net.Quic.QuicStream" /> can be used in a same way as any other <see cref="T:System.IO.Stream" />.

Apart from a stream API, <see cref="T:System.Net.Quic.QuicStream" /> also exposes QUIC-specific features:

<list type="bullet"><item><term><see cref="M:System.Net.Quic.QuicStream.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Boolean,System.Threading.CancellationToken)" /></term><description>Closes the writing side of the stream as a single operation with the write itself.</description></item><item><term><see cref="M:System.Net.Quic.QuicStream.CompleteWrites" /></term><description>Closes the writing side of the stream.</description></item><item><term><see cref="M:System.Net.Quic.QuicStream.Abort(System.Net.Quic.QuicAbortDirection,System.Int64)" /></term><description>Aborts either the writing or the reading side of the stream.</description></item><item><term><see cref="M:System.Net.Quic.QuicStream.WritesClosed" /></term><description>Returns a <see cref="T:System.Threading.Tasks.Task" /> that will complete when the stream writing side has been closed (gracefully or abortively).</description></item><item><term><see cref="P:System.Net.Quic.QuicStream.ReadsClosed" /></term><description>Returns a <see cref="T:System.Threading.Tasks.Task" /> that will complete when the stream reading side has been closed (gracefully or abortively).</description></item></list></remarks>
<related type="Article" href="https://www.rfc-editor.org/rfc/rfc9000.html#name-streams">RFC 9000: Streams</related>
</Docs>
Expand Down Expand Up @@ -62,12 +62,12 @@ Apart from a stream API, <see cref="T:System.Net.Quic.QuicStream" /> also expose
<param name="errorCode">The error code with which to abort the stream. This value is application-protocol (which is the layer above QUIC) dependent.</param>
<summary>Aborts either the <see cref="F:System.Net.Quic.QuicAbortDirection.Read">reading</see>, <see cref="F:System.Net.Quic.QuicAbortDirection.Write">writing</see>, or <see cref="F:System.Net.Quic.QuicAbortDirection.Both">both</see> sides of the stream.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Corresponds to [STOP_SENDING](https://www.rfc-editor.org/rfc/rfc9000.html#frame-stop-sending) and [RESET_STREAM](https://www.rfc-editor.org/rfc/rfc9000.html#frame-reset-stream) QUIC frames.
<format type="text/markdown"><![CDATA[

## Remarks

Corresponds to [STOP_SENDING](https://www.rfc-editor.org/rfc/rfc9000.html#frame-stop-sending) and [RESET_STREAM](https://www.rfc-editor.org/rfc/rfc9000.html#frame-reset-stream) QUIC frames.

]]></format>
</remarks>
</Docs>
Expand Down Expand Up @@ -293,14 +293,14 @@ Corresponds to [STOP_SENDING](https://www.rfc-editor.org/rfc/rfc9000.html#frame-
<Docs>
<summary>Gracefully completes the writing side of the stream.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Corresponds to an empty [STREAM](https://www.rfc-editor.org/rfc/rfc9000.html#frame-stream) frame with `FIN` flag set to `true`.
Equivalent to using <xref:System.Net.Quic.QuicStream.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Boolean,System.Threading.CancellationToken)> with `completeWrites: true`.
<format type="text/markdown"><![CDATA[

## Remarks

Corresponds to an empty [STREAM](https://www.rfc-editor.org/rfc/rfc9000.html#frame-stream) frame with `FIN` flag set to `true`.

Equivalent to using <xref:System.Net.Quic.QuicStream.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Boolean,System.Threading.CancellationToken)> with `completeWrites: true`.

]]></format>
</remarks>
</Docs>
Expand Down
6 changes: 3 additions & 3 deletions xml/System.Net.Quic/QuicStreamCapacityChangedArgs.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Arguments for <see cref="P:System.Net.Quic.QuicConnectionOptions.StreamCapacityCallback" />.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -40,7 +40,7 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The increment saying how many additional bidirectional streams can be opened on the connection, increased via the latest MAX_STREAMS frame.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -61,7 +61,7 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The increment saying how many additional unidirectional streams can be opened on the connection, increased via the latest MAX_STREAMS frame.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down