Parse named pipe endpoint from URL with BindingAddress

[JamesNK]

Background and Motivation

Named pipe endpoints should be parsable from Kestrel url arg.

Proposed API

namespace Microsoft.AspNetCore.Http;

public class BindingAddress
{
+    public bool IsNamedPipe { get; }
+    public string NamedPipePath { get; }
}

Usage Examples

var parsedAddress = BindingAddress.Parse("http://pipe:PipeName");

if (parsedAddress.IsNamedPipe)
{
    return new ListenOptions(new NamedPipeEndPoint(parsedAddress.NamedPipePath));
}

Alternative Designs

There are IsUnixPipe and UnixPipePath properties already on this type. Is "Named" vs "Unix" clear enough about which is which? We refer to them as name pipes everywhere else.

---

Named pipes have a format for the name, e.g. \\.\pipe\PipeName - https://learn.microsoft.com/en-us/windows/win32/ipc/pipe-names. I chose not to use it, and simply anything after pipe: is the pipe name. This is consistent with unix:/ for UDS and keeps the URL simpler.

If we did use the known format, then the usage example would look like this:

var parsedAddress = BindingAddress.Parse(@"http://\\.\pipe\PipeName");

---

public string NamedPipePath { get; } could be changed to public string NamedPipeName { get; }. NamedPipeName is a little awkward, but more accurate to named pipe terms.

Risks

Thank you for submitting this for API review. This will be reviewed by @dotnet/aspnet-api-review at the next meeting of the ASP.NET Core API Review group. Please ensure you take a look at the API review process documentation and ensure that:

• The PR contains changes to the reference-assembly that describe the API change. Or, you have included a snippet of reference-assembly-style code that illustrates the API change.
• The PR describes the impact to users, both positive (useful new APIs) and negative (breaking changes).
• Someone is assigned to "champion" this change in the meeting, and they understand the impact and design of the change.

[Tratcher]

Or just PipeName or NamedPipe?

Thanks for contacting us.

We're moving this issue to the .NET 8 Planning milestone for future evaluation / consideration. We would like to keep this around to collect more feedback, which can help us with prioritizing this work. We will re-evaluate this issue, during our next planning meeting(s).
If we later determine, that the issue has no community involvement, or it's very rare and low-impact issue, we will close it - so that the team can focus on more important and high impact issues.
To learn more about what to expect next and how this issue will be handled you can read more about our triage process here.

[halter73]

API Review Notes:

1. Is "http://pipe:PipeName" ambiguous with a normal HTTP server an port? And a pipe have a fully numeric name? Yes.

• Should we require a forward slash like Unix domain sockets (e.g. "http://unix:/path/to.socket")?
• We'll get back to this with email API review.

2. NamedPipePath isn't really a path. Let's use "NamedPipeName".

namespace Microsoft.AspNetCore.Http;

public class BindingAddress
{
+    public bool IsNamedPipe { get; }
+    public string NamedPipeName { get; }
}

API Approved!

[JamesNK]

Done with #44426