Skip to content

Add link to QUIC prerequisities and supported operating systems #8750

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jkotas merged 2 commits into from
Jan 2, 2023
Merged

Add link to QUIC prerequisities and supported operating systems #8750

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
135272d
Add link to QUIC prerequisities and supported operating systems
jkotas Dec 29, 2022
b8023f0
Apply suggestions from code review
jkotas Dec 29, 2022
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
Next Next commit
Add link to QUIC prerequisities and supported operating systems 
Fixes dotnet/runtime#80001
  • Loading branch information
@jkotas
jkotas committed Dec 29, 2022
commit 135272d89f6eff23e42f60b6eef02bac941dcaaf
8 changes: 4 additions & 4 deletions xml/System.Net.Quic/QuicConnection.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ A <xref:System.Net.Quic.QuicConnection> can either be accepted from <xref:System

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)>.

See <see href="/dotnet/core/extensions/httpclient-http3#platform-dependencies">Platform dependencies</see> for QUIC prerequisities and supported operating systems.

]]></format>
</remarks>
<related type="Article" href="https://www.rfc-editor.org/rfc/rfc9000.html#name-connections">RFC 9000: Connections</related>
Expand Down Expand Up @@ -161,12 +163,10 @@ If <xref:System.Net.Quic.QuicConnection.CloseAsync(System.Int64,System.Threading
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates whether QUIC is supported on the current machine.</summary>
<summary>Gets a value that indicates whether QUIC is supported for client scenarios on the current machine.</summary>
<value>
<see langword="true" /> if QUIC is supported on the current machine and can be used; otherwise, <see langword="false" />.</value>
<remarks>The current implementation depends on <see href="https://github.com/microsoft/msquic">MsQuic</see> native library, this property checks its presence (Linux machines).

It also checks whether TLS 1.3, requirement for QUIC protocol, is available and enabled (Windows machines).</remarks>
<remarks>See <see href="/dotnet/core/extensions/httpclient-http3#platform-dependencies">Platform dependencies</see> for QUIC prerequisities and supported operating systems.</remarks>
</Docs>
</Member>
<Member MemberName="LocalEndPoint">
Expand Down
8 changes: 4 additions & 4 deletions xml/System.Net.Quic/QuicListener.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@

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.

See <see href="/dotnet/core/extensions/httpclient-http3#platform-dependencies">Platform dependencies</see> for QUIC prerequisities and supported operating systems.

]]></format>
</remarks>
<related type="Article" href="https://www.rfc-editor.org/rfc/rfc9000.html#name-connections">RFC 9000: Connections</related>
Expand Down Expand Up @@ -106,12 +108,10 @@ This method propagates exceptions from <xref:System.Net.Quic.QuicListenerOptions
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates whether QUIC is supported on the current machine.</summary>
<summary>Gets a value that indicates whether QUIC is supported for server scenarios on the current machine.</summary>
<value>
<see langword="true" /> if QUIC is supported on the current machine and can be used; otherwise, <see langword="false" />.</value>
<remarks>The current implementation depends on <see href="https://github.com/microsoft/msquic">MsQuic</see> native library, this property checks its presence (Linux machines).

It also checks whether TLS 1.3, requirement for QUIC protocol, is available and enabled (Windows machines).</remarks>
<remarks>See <see href="/dotnet/core/extensions/httpclient-http3#platform-dependencies">Platform dependencies</see> for QUIC prerequisities and supported operating systems.</remarks>
</Docs>
</Member>
<Member MemberName="ListenAsync">
Expand Down