From 8f25c4e8ca11871eac728f69c2bb256501a1838e Mon Sep 17 00:00:00 2001 From: Redouane Sobaihi Date: Thu, 8 Feb 2018 20:37:01 +0100 Subject: [PATCH] Include limits default values in intellisense comments. (#2304) --- src/Kestrel.Core/KestrelServerLimits.cs | 30 ++++++++++++------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/src/Kestrel.Core/KestrelServerLimits.cs b/src/Kestrel.Core/KestrelServerLimits.cs index 6cd16e9a6b..f2f8e773ac 100644 --- a/src/Kestrel.Core/KestrelServerLimits.cs +++ b/src/Kestrel.Core/KestrelServerLimits.cs @@ -43,12 +43,12 @@ namespace Microsoft.AspNetCore.Server.Kestrel.Core /// Gets or sets the maximum size of the response buffer before write /// calls begin to block or return tasks that don't complete until the /// buffer size drops below the configured limit. + /// Defaults to 65,536 bytes (64 KB). /// /// /// When set to null, the size of the response buffer is unlimited. /// When set to zero, all write calls will block or return tasks that /// don't complete until the entire response buffer is flushed. - /// Defaults to 65,536 bytes (64 KB). /// public long? MaxResponseBufferSize { @@ -65,10 +65,10 @@ namespace Microsoft.AspNetCore.Server.Kestrel.Core /// /// Gets or sets the maximum size of the request buffer. + /// Defaults to 1,048,576 bytes (1 MB). /// /// /// When set to null, the size of the request buffer is unlimited. - /// Defaults to 1,048,576 bytes (1 MB). /// public long? MaxRequestBufferSize { @@ -85,9 +85,9 @@ namespace Microsoft.AspNetCore.Server.Kestrel.Core /// /// Gets or sets the maximum allowed size for the HTTP request line. + /// Defaults to 8,192 bytes (8 KB). /// /// - /// Defaults to 8,192 bytes (8 KB). /// public int MaxRequestLineSize { @@ -104,9 +104,9 @@ namespace Microsoft.AspNetCore.Server.Kestrel.Core /// /// Gets or sets the maximum allowed size for the HTTP request headers. + /// Defaults to 32,768 bytes (32 KB). /// /// - /// Defaults to 32,768 bytes (32 KB). /// public int MaxRequestHeadersTotalSize { @@ -123,9 +123,9 @@ namespace Microsoft.AspNetCore.Server.Kestrel.Core /// /// Gets or sets the maximum allowed number of headers per HTTP request. + /// Defaults to 100. /// /// - /// Defaults to 100. /// public int MaxRequestHeaderCount { @@ -145,9 +145,9 @@ namespace Microsoft.AspNetCore.Server.Kestrel.Core /// When set to null, the maximum request body size is unlimited. /// This limit has no effect on upgraded connections which are always unlimited. /// This can be overridden per-request via . + /// Defaults to 30,000,000 bytes, which is approximately 28.6MB. /// /// - /// Defaults to 30,000,000 bytes, which is approximately 28.6MB. /// public long? MaxRequestBodySize { @@ -164,9 +164,9 @@ namespace Microsoft.AspNetCore.Server.Kestrel.Core /// /// Gets or sets the keep-alive timeout. + /// Defaults to 2 minutes. /// /// - /// Defaults to 2 minutes. /// public TimeSpan KeepAliveTimeout { @@ -183,9 +183,9 @@ namespace Microsoft.AspNetCore.Server.Kestrel.Core /// /// Gets or sets the maximum amount of time the server will spend receiving request headers. + /// Defaults to 30 seconds. /// /// - /// Defaults to 30 seconds. /// public TimeSpan RequestHeadersTimeout { @@ -202,11 +202,11 @@ namespace Microsoft.AspNetCore.Server.Kestrel.Core /// /// Gets or sets the maximum number of open connections. When set to null, the number of connections is unlimited. - /// - /// /// /// Defaults to null. /// + /// + /// /// /// When a connection is upgraded to another protocol, such as WebSockets, its connection is counted against the /// limit instead of . @@ -228,11 +228,11 @@ namespace Microsoft.AspNetCore.Server.Kestrel.Core /// /// Gets or sets the maximum number of open, upgraded connections. When set to null, the number of upgraded connections is unlimited. /// An upgraded connection is one that has been switched from HTTP to another protocol, such as WebSockets. - /// - /// /// /// Defaults to null. /// + /// + /// /// /// When a connection is upgraded to another protocol, such as WebSockets, its connection is counted against the /// limit instead of . @@ -256,9 +256,9 @@ namespace Microsoft.AspNetCore.Server.Kestrel.Core /// Setting this property to null indicates no minimum data rate should be enforced. /// This limit has no effect on upgraded connections which are always unlimited. /// This can be overridden per-request via . + /// Defaults to 240 bytes/second with a 5 second grace period. /// /// - /// Defaults to 240 bytes/second with a 5 second grace period. /// public MinDataRate MinRequestBodyDataRate { get; set; } = // Matches the default IIS minBytesPerSecond @@ -269,11 +269,11 @@ namespace Microsoft.AspNetCore.Server.Kestrel.Core /// Setting this property to null indicates no minimum data rate should be enforced. /// This limit has no effect on upgraded connections which are always unlimited. /// This can be overridden per-request via . - /// - /// /// /// Defaults to 240 bytes/second with a 5 second grace period. /// + /// + /// /// /// Contrary to the request body minimum data rate, this rate applies to the response status line and headers as well. ///