Skip to content

Commit 067e4df

Browse files
committed
Listener options fixes
1 parent 55df97b commit 067e4df

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

xml/System.Net.Quic/QuicListener.xml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,10 @@ For QUIC prerequisites and supported operating systems, see [Platform dependenci
6969
7070
## Remarks
7171
72-
<xref:System.Net.Quic.QuicListener> doesn't have a mechanism to report inbound connections that fail the handshake process. Such connections are only logged by the listener and never surfaced on the outside.
73-
74-
This method propagates exceptions from <xref:System.Net.Quic.QuicListenerOptions.ConnectionOptionsCallback>, including validation errors from misconfigured <xref:System.Net.Quic.QuicServerConnectionOptions>, for example, <xref:System.ArgumentException>. It also propagates exceptions from failed connection handshakes, for example, <xref:System.Security.Authentication.AuthenticationException> and <xref:System.Net.Quic.QuicException>.
72+
This method also propagates exceptions from the process of establishing a connection, including:
73+
- Errors from <xref:System.Net.Quic.QuicListenerOptions.ConnectionOptionsCallback> as <xref:System.Net.Quic.QuicException> with <xref:System.Net.Quic.QuicError.CallbackError> error type.
74+
- Validation errors from misconfigured <xref:System.Net.Quic.QuicServerConnectionOptions> returned by <xref:System.Net.Quic.QuicListenerOptions.ConnectionOptionsCallback> as <xref:System.ArgumentException>.
75+
- Exceptions from failed connection handshakes as <xref:System.Security.Authentication.AuthenticationException> or <xref:System.Net.Quic.QuicException>.
7576
7677
]]></format>
7778
</remarks>

xml/System.Net.Quic/QuicListenerOptions.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
</Attribute>
2323
</Attributes>
2424
<Docs>
25-
<summary>Options to provide to a <see cref="T:System.Net.Quic.QuicListener" />.</summary>
25+
<summary>Options to configure a new <see cref="T:System.Net.Quic.QuicListener" />.</summary>
2626
<remarks>To be added.</remarks>
2727
</Docs>
2828
<Members>
@@ -65,7 +65,7 @@
6565
<Docs>
6666
<summary>Gets or sets the list of application protocols that the listener will accept. At least one must be specified.</summary>
6767
<value>To be added.</value>
68-
<remarks>This property is mandatory, and not setting it will result in validation errors when starting the listener.</remarks>
68+
<remarks>This property is mandatory, not setting or not specifying at least one value will result in validation errors when starting the listener.</remarks>
6969
</Docs>
7070
</Member>
7171
<Member MemberName="ConnectionOptionsCallback">
@@ -92,9 +92,9 @@
9292
<ReturnType>System.Func&lt;System.Net.Quic.QuicConnection,System.Net.Security.SslClientHelloInfo,System.Threading.CancellationToken,System.Threading.Tasks.ValueTask&lt;System.Net.Quic.QuicServerConnectionOptions&gt;&gt;</ReturnType>
9393
</ReturnValue>
9494
<Docs>
95-
<summary>Gets or sets the selection callback to choose inbound connection options dynamically.</summary>
95+
<summary>Gets or sets the selection callback to choose inbound connection options.</summary>
9696
<value>To be added.</value>
97-
<remarks>To be added.</remarks>
97+
<remarks>This property is mandatory, not setting it will result in validation errors when starting the listener.</remarks>
9898
</Docs>
9999
</Member>
100100
<Member MemberName="ListenBacklog">
@@ -115,7 +115,7 @@
115115
<ReturnType>System.Int32</ReturnType>
116116
</ReturnValue>
117117
<Docs>
118-
<summary>Gets or sets the number of connections to be held without accepting any of them, that is, the maximum size of the pending connection queue.</summary>
118+
<summary>Gets or sets the number of connections to be held without accepting any of them. That is, the maximum size of the pending connection queue.</summary>
119119
<value>To be added.</value>
120120
<remarks>To be added.</remarks>
121121
</Docs>
@@ -140,7 +140,7 @@
140140
<Docs>
141141
<summary>Gets or sets the endpoint to listen on.</summary>
142142
<value>To be added.</value>
143-
<remarks>This property is mandatory, and not setting it will result in validation errors when starting the listener.</remarks>
143+
<remarks>This property is mandatory, not setting will result in validation errors when starting the listener.</remarks>
144144
</Docs>
145145
</Member>
146146
</Members>

0 commit comments

Comments
 (0)