Skip to content

Commit 1e0f2ca

Browse files
jkotasgewarren
andauthored
Add link to QUIC prerequisities and supported operating systems (dotnet#8750)
* Add link to QUIC prerequisities and supported operating systems Fixes dotnet/runtime#80001 Co-authored-by: Genevieve Warren <[email protected]>
1 parent 2db7920 commit 1e0f2ca

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

xml/System.Net.Quic/QuicConnection.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ A <xref:System.Net.Quic.QuicConnection> can either be accepted from <xref:System
2828
2929
Each connection can then open an outbound stream using <xref:System.Net.Quic.QuicConnection.OpenOutboundStreamAsync(System.Net.Quic.QuicStreamType,System.Threading.CancellationToken)> or accept an inbound stream using <xref:System.Net.Quic.QuicConnection.AcceptInboundStreamAsync(System.Threading.CancellationToken)>.
3030
31+
For QUIC prerequisites and supported operating systems, see [Platform dependencies](/dotnet/core/extensions/httpclient-http3#platform-dependencies).
32+
3133
]]></format>
3234
</remarks>
3335
<related type="Article" href="https://www.rfc-editor.org/rfc/rfc9000.html#name-connections">RFC 9000: Connections</related>
@@ -161,12 +163,10 @@ If <xref:System.Net.Quic.QuicConnection.CloseAsync(System.Int64,System.Threading
161163
<ReturnType>System.Boolean</ReturnType>
162164
</ReturnValue>
163165
<Docs>
164-
<summary>Gets a value that indicates whether QUIC is supported on the current machine.</summary>
166+
<summary>Gets a value that indicates whether QUIC is supported for client scenarios on the current machine.</summary>
165167
<value>
166168
<see langword="true" /> if QUIC is supported on the current machine and can be used; otherwise, <see langword="false" />.</value>
167-
<remarks>The current implementation depends on <see href="https://github.com/microsoft/msquic">MsQuic</see> native library, this property checks its presence (Linux machines).
168-
169-
It also checks whether TLS 1.3, requirement for QUIC protocol, is available and enabled (Windows machines).</remarks>
169+
<remarks>For QUIC prerequisites and supported operating systems, see <see href="/dotnet/core/extensions/httpclient-http3#platform-dependencies">Platform dependencies</see>.</remarks>
170170
</Docs>
171171
</Member>
172172
<Member MemberName="LocalEndPoint">

xml/System.Net.Quic/QuicListener.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@
2626
2727
Unlike the connection and stream, the lifetime of a <xref:System.Net.Quic.QuicListener> isn't linked to any of the accepted connections. It can be safely disposed while keeping the accepted connection alive. Calling <xref:System.Net.Quic.QuicListener.DisposeAsync> will only cause the listener to stop listening for any other inbound connections.
2828
29+
For QUIC prerequisites and supported operating systems, see [Platform dependencies](/dotnet/core/extensions/httpclient-http3#platform-dependencies).
30+
2931
]]></format>
3032
</remarks>
3133
<related type="Article" href="https://www.rfc-editor.org/rfc/rfc9000.html#name-connections">RFC 9000: Connections</related>
@@ -106,12 +108,10 @@ This method propagates exceptions from <xref:System.Net.Quic.QuicListenerOptions
106108
<ReturnType>System.Boolean</ReturnType>
107109
</ReturnValue>
108110
<Docs>
109-
<summary>Gets a value that indicates whether QUIC is supported on the current machine.</summary>
111+
<summary>Gets a value that indicates whether QUIC is supported for server scenarios on the current machine.</summary>
110112
<value>
111113
<see langword="true" /> if QUIC is supported on the current machine and can be used; otherwise, <see langword="false" />.</value>
112-
<remarks>The current implementation depends on <see href="https://github.com/microsoft/msquic">MsQuic</see> native library, this property checks its presence (Linux machines).
113-
114-
It also checks whether TLS 1.3, requirement for QUIC protocol, is available and enabled (Windows machines).</remarks>
114+
<remarks>For QUIC prerequisites and supported operating systems, see <see href="/dotnet/core/extensions/httpclient-http3#platform-dependencies">Platform dependencies</see>.</remarks>
115115
</Docs>
116116
</Member>
117117
<Member MemberName="ListenAsync">

0 commit comments

Comments
 (0)