API Proposal: Consider adding a WaitForDataBeforeAllocatingBuffer in HttpsConnectionMiddleware

[davidfowl]

Background and Motivation

As part of #30863, we're doing zero byte reads as a way to save memory. In some cases it might be better for performance (like in HTTPs based benchmarks), if we don't do a zero byte read before the actual read. Note, this isn't as big a deal as in the transport layer because it's not a real sys call we're making. We're calling into an in memory implementation.

Proposed API

namespace Microsoft.AspNetCore.Server.Kestrel.Https
{
    public class HttpsConnectionAdapterOptions
    {
+       public bool WaitForDataBeforeAllocatingBuffer { get; set; }
    }

Usage Examples

var host = new HostBuilder()
                .ConfigureWebHost(webHostBuilder =>
                {
                    webHostBuilder
                        .UseKestrel(options =>
                        {
                            options.Listen(IPAddress.Loopback, 5001, o => o.UseHttps(https => https.WaitForDataBeforeAllocatingBuffer = true ));
                        })
                        .UseStartup<Startup>();
                })
                .Build();

            await host.RunAsync();

Risks

None.

[BrennanConroy]

Triage: Can we see numbers before doing this?

[davidfowl]

Yea, agreed, I don't want to do it.

We've moved this issue to the Backlog milestone. This means that it is not going to be worked on for the coming release. We will reassess the backlog following the current release and consider this item at that time. To learn more about our issue management process and to have better expectation regarding different types of issues you can read our Triage Process.

[davidfowl]

Seems like it isn't needed for the most part.