From bb2e2a916006889f669b5532122f1442a2576c82 Mon Sep 17 00:00:00 2001 From: huysentruitw Date: Thu, 26 Mar 2020 19:02:30 +0100 Subject: [PATCH] Obsolete ReceiveBufferSize in WebSocketOptions #20084 (#20189) * Obsolete ReceiveBufferSize in WebSocketOptions * Update reference * Update obsolete messages --- .../ref/Microsoft.AspNetCore.WebSockets.netcoreapp.cs | 2 ++ .../WebSockets/src/ExtendedWebSocketAcceptContext.cs | 5 ++++- src/Middleware/WebSockets/src/WebSocketMiddleware.cs | 5 ----- src/Middleware/WebSockets/src/WebSocketOptions.cs | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/Middleware/WebSockets/ref/Microsoft.AspNetCore.WebSockets.netcoreapp.cs b/src/Middleware/WebSockets/ref/Microsoft.AspNetCore.WebSockets.netcoreapp.cs index eb25bc39ae..01784c273b 100644 --- a/src/Middleware/WebSockets/ref/Microsoft.AspNetCore.WebSockets.netcoreapp.cs +++ b/src/Middleware/WebSockets/ref/Microsoft.AspNetCore.WebSockets.netcoreapp.cs @@ -13,6 +13,7 @@ namespace Microsoft.AspNetCore.Builder public WebSocketOptions() { } public System.Collections.Generic.IList AllowedOrigins { [System.Runtime.CompilerServices.CompilerGeneratedAttribute] get { throw null; } } public System.TimeSpan KeepAliveInterval { [System.Runtime.CompilerServices.CompilerGeneratedAttribute] get { throw null; } [System.Runtime.CompilerServices.CompilerGeneratedAttribute] set { } } + [System.ObsoleteAttribute("Setting this property has no effect. It will be removed in a future version.")] public int ReceiveBufferSize { [System.Runtime.CompilerServices.CompilerGeneratedAttribute] get { throw null; } [System.Runtime.CompilerServices.CompilerGeneratedAttribute] set { } } } } @@ -22,6 +23,7 @@ namespace Microsoft.AspNetCore.WebSockets { public ExtendedWebSocketAcceptContext() { } public System.TimeSpan? KeepAliveInterval { [System.Runtime.CompilerServices.CompilerGeneratedAttribute] get { throw null; } [System.Runtime.CompilerServices.CompilerGeneratedAttribute] set { } } + [System.ObsoleteAttribute("Setting this property has no effect. It will be removed in a future version.")] public int? ReceiveBufferSize { [System.Runtime.CompilerServices.CompilerGeneratedAttribute] get { throw null; } [System.Runtime.CompilerServices.CompilerGeneratedAttribute] set { } } public override string SubProtocol { [System.Runtime.CompilerServices.CompilerGeneratedAttribute] get { throw null; } [System.Runtime.CompilerServices.CompilerGeneratedAttribute] set { } } } diff --git a/src/Middleware/WebSockets/src/ExtendedWebSocketAcceptContext.cs b/src/Middleware/WebSockets/src/ExtendedWebSocketAcceptContext.cs index 23186d7eb5..d4c7970696 100644 --- a/src/Middleware/WebSockets/src/ExtendedWebSocketAcceptContext.cs +++ b/src/Middleware/WebSockets/src/ExtendedWebSocketAcceptContext.cs @@ -9,7 +9,10 @@ namespace Microsoft.AspNetCore.WebSockets public class ExtendedWebSocketAcceptContext : WebSocketAcceptContext { public override string SubProtocol { get; set; } + + [Obsolete("Setting this property has no effect. It will be removed in a future version.")] public int? ReceiveBufferSize { get; set; } + public TimeSpan? KeepAliveInterval { get; set; } } -} \ No newline at end of file +} diff --git a/src/Middleware/WebSockets/src/WebSocketMiddleware.cs b/src/Middleware/WebSockets/src/WebSocketMiddleware.cs index d76100f4a4..6ad67c216d 100644 --- a/src/Middleware/WebSockets/src/WebSocketMiddleware.cs +++ b/src/Middleware/WebSockets/src/WebSocketMiddleware.cs @@ -131,14 +131,9 @@ namespace Microsoft.AspNetCore.WebSockets } TimeSpan keepAliveInterval = _options.KeepAliveInterval; - int receiveBufferSize = _options.ReceiveBufferSize; var advancedAcceptContext = acceptContext as ExtendedWebSocketAcceptContext; if (advancedAcceptContext != null) { - if (advancedAcceptContext.ReceiveBufferSize.HasValue) - { - receiveBufferSize = advancedAcceptContext.ReceiveBufferSize.Value; - } if (advancedAcceptContext.KeepAliveInterval.HasValue) { keepAliveInterval = advancedAcceptContext.KeepAliveInterval.Value; diff --git a/src/Middleware/WebSockets/src/WebSocketOptions.cs b/src/Middleware/WebSockets/src/WebSocketOptions.cs index da5f630d62..5bf4a15195 100644 --- a/src/Middleware/WebSockets/src/WebSocketOptions.cs +++ b/src/Middleware/WebSockets/src/WebSocketOptions.cs @@ -14,7 +14,6 @@ namespace Microsoft.AspNetCore.Builder public WebSocketOptions() { KeepAliveInterval = TimeSpan.FromMinutes(2); - ReceiveBufferSize = 4 * 1024; AllowedOrigins = new List(); } @@ -28,6 +27,7 @@ namespace Microsoft.AspNetCore.Builder /// Gets or sets the size of the protocol buffer used to receive and parse frames. /// The default is 4kb. /// + [Obsolete("Setting this property has no effect. It will be removed in a future version.")] public int ReceiveBufferSize { get; set; } /// @@ -36,4 +36,4 @@ namespace Microsoft.AspNetCore.Builder /// public IList AllowedOrigins { get; } } -} \ No newline at end of file +}