diff --git a/xml/System.Net.Quic/QuicClientConnectionOptions.xml b/xml/System.Net.Quic/QuicClientConnectionOptions.xml index ffbf9460b84..291ea2d4f4d 100644 --- a/xml/System.Net.Quic/QuicClientConnectionOptions.xml +++ b/xml/System.Net.Quic/QuicClientConnectionOptions.xml @@ -24,6 +24,7 @@ Options for client (outbound) Quic connections. To be added. + Detailed documentation for QuicClientConnectionOptions diff --git a/xml/System.Net.Quic/QuicConnection.xml b/xml/System.Net.Quic/QuicConnection.xml index 62319c6c1c1..fdac2187660 100644 --- a/xml/System.Net.Quic/QuicConnection.xml +++ b/xml/System.Net.Quic/QuicConnection.xml @@ -41,6 +41,7 @@ For QUIC prerequisites and supported operating systems, see [Platform dependenci ]]> RFC 9000: Connections + Guidelines for using QuicConnection diff --git a/xml/System.Net.Quic/QuicConnectionOptions.xml b/xml/System.Net.Quic/QuicConnectionOptions.xml index c798b59e21c..d584bcd7613 100644 --- a/xml/System.Net.Quic/QuicConnectionOptions.xml +++ b/xml/System.Net.Quic/QuicConnectionOptions.xml @@ -24,6 +24,7 @@ Shared options for both client (outbound) and server (inbound) Quic connections. To be added. + Detailed documentation for QuicConnectionOptions @@ -164,8 +165,8 @@ To use a different close error code, call System.TimeSpan - Gets or sets the interval at which keep-alive packets are sent on the connection. - The interval at which keep-alive packets are sent on the connection. The default value is , which means keep-alive packets are never sent. + Gets or sets the interval at which PING frames are sent on the connection. + The interval at which PING frames are sent on the connection. The default value is , which means PING frames are never sent. A value of means use the underlying implementation default timeout. @@ -239,11 +240,12 @@ To use a different close error code, call Optional callback that is invoked when new stream limit is released by the peer. Corresponds to receiving a MAX_STREAMS frame. - The callback values represent increments of stream limits, e.g.: current limit is 10 bidirectional streams, callback arguments notify 5 more additional bidirectional streams => 15 bidirectional streams can be opened in total at the moment. - The initial capacity is reported with the first invocation of the callback that might happen before the instance is handed out via either or . To be added. - To be added. + + The callback values represent increments of stream limits. For example, if the current limit is 10 bidirectional streams, and callback arguments notify 5 more additional bidirectional streams, then 15 bidirectional streams can be opened in total at the moment. + The initial capacity is reported with the first invocation of the callback, which might happen before the instance is handed out via either or . + diff --git a/xml/System.Net.Quic/QuicListener.xml b/xml/System.Net.Quic/QuicListener.xml index 34a5a94c001..50d6a520fcf 100644 --- a/xml/System.Net.Quic/QuicListener.xml +++ b/xml/System.Net.Quic/QuicListener.xml @@ -39,6 +39,7 @@ For QUIC prerequisites and supported operating systems, see [Platform dependenci ]]> RFC 9000: Connections + Guidelines for using QuicListener @@ -69,9 +70,10 @@ For QUIC prerequisites and supported operating systems, see [Platform dependenci ## Remarks - 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. - -This method propagates exceptions from , including validation errors from misconfigured , for example, . It also propagates exceptions from failed connection handshakes, for example, and . +This method also propagates exceptions from the process of establishing a connection, including: +- Errors from as with error type. +- Validation errors from misconfigured returned by as . +- Exceptions from failed connection handshakes as or . ]]> diff --git a/xml/System.Net.Quic/QuicListenerOptions.xml b/xml/System.Net.Quic/QuicListenerOptions.xml index 6d787b65425..213048a832b 100644 --- a/xml/System.Net.Quic/QuicListenerOptions.xml +++ b/xml/System.Net.Quic/QuicListenerOptions.xml @@ -22,8 +22,9 @@ - Options to provide to a . + Options to configure a new . To be added. + Detailed documentation for QuicListenerOptions @@ -65,7 +66,7 @@ Gets or sets the list of application protocols that the listener will accept. At least one must be specified. To be added. - This property is mandatory, and not setting it will result in validation errors when starting the listener. + This property is mandatory. Not setting it or not specifying at least one value will result in validation errors when starting the listener. @@ -92,9 +93,9 @@ System.Func<System.Net.Quic.QuicConnection,System.Net.Security.SslClientHelloInfo,System.Threading.CancellationToken,System.Threading.Tasks.ValueTask<System.Net.Quic.QuicServerConnectionOptions>> - Gets or sets the selection callback to choose inbound connection options dynamically. + Gets or sets the selection callback to choose inbound connection options. To be added. - To be added. + This property is mandatory. Not setting it will result in validation errors when starting the listener. @@ -115,7 +116,7 @@ System.Int32 - 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. + 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. To be added. To be added. @@ -140,7 +141,7 @@ Gets or sets the endpoint to listen on. To be added. - This property is mandatory, and not setting it will result in validation errors when starting the listener. + This property is mandatory. Not setting it will result in validation errors when starting the listener. diff --git a/xml/System.Net.Quic/QuicReceiveWindowSizes.xml b/xml/System.Net.Quic/QuicReceiveWindowSizes.xml index daf3a885273..52413125838 100644 --- a/xml/System.Net.Quic/QuicReceiveWindowSizes.xml +++ b/xml/System.Net.Quic/QuicReceiveWindowSizes.xml @@ -53,7 +53,7 @@ Gets or sets the initial flow-control window size for the connection. To be added. - To be added. + Must be non-negative power of 2. @@ -74,7 +74,7 @@ Gets or sets the initial flow-control window size for locally initiated bidirectional streams. To be added. - To be added. + Must be non-negative power of 2. @@ -95,7 +95,7 @@ Gets or sets the initial flow-control window size for remotely initiated bidirectional streams. To be added. - To be added. + Must be non-negative power of 2. @@ -116,7 +116,7 @@ Gets or sets the initial flow-control window size for (remotely initiated) unidirectional streams. To be added. - To be added. + Must be non-negative power of 2. diff --git a/xml/System.Net.Quic/QuicServerConnectionOptions.xml b/xml/System.Net.Quic/QuicServerConnectionOptions.xml index 487fef054df..d72df564def 100644 --- a/xml/System.Net.Quic/QuicServerConnectionOptions.xml +++ b/xml/System.Net.Quic/QuicServerConnectionOptions.xml @@ -24,6 +24,7 @@ Options for server (inbound) Quic connections. These options are provided by . To be added. + Detailed documentation for QuicServerConnectionOptions diff --git a/xml/System.Net.Quic/QuicStream.xml b/xml/System.Net.Quic/QuicStream.xml index 49a47857460..efaa94798e3 100644 --- a/xml/System.Net.Quic/QuicStream.xml +++ b/xml/System.Net.Quic/QuicStream.xml @@ -30,6 +30,7 @@ Apart from a stream API, also expose Closes the writing side of the stream as a single operation with the write itself.Closes the writing side of the stream.Aborts either the writing or the reading side of the stream.Returns a that will complete when the stream writing side has been closed (gracefully or abortively).Returns a that will complete when the stream reading side has been closed (gracefully or abortively). RFC 9000: Streams + Guidelines for using QuicStream diff --git a/xml/ns-System.Net.Quic.Implementations.xml b/xml/ns-System.Net.Quic.Implementations.xml deleted file mode 100644 index e1a217559e7..00000000000 --- a/xml/ns-System.Net.Quic.Implementations.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - To be added. - To be added. - - diff --git a/xml/ns-System.Net.Quic.xml b/xml/ns-System.Net.Quic.xml index 2dc840c230f..7abb48641fe 100644 --- a/xml/ns-System.Net.Quic.xml +++ b/xml/ns-System.Net.Quic.xml @@ -1,6 +1,7 @@ - Contains types that implement the QUIC protocol specified by RFC 9000. + Contains types that implement the QUIC protocol specified by RFC 9000. To be added. + QUIC in .NET