Add named pipes methods to Kestrel configuration loader (#56563)

dotnet · Jul 4, 2024 · 75368e2 · 75368e2
1 parent 8bf9970
commit 75368e2
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 0 deletions.
diff --git a/src/Servers/Kestrel/Core/src/KestrelConfigurationLoader.cs b/src/Servers/Kestrel/Core/src/KestrelConfigurationLoader.cs
@@ -191,6 +191,27 @@ public KestrelConfigurationLoader UnixSocketEndpoint(string socketPath, Action<L
         return this;
     }
 
+    /// <summary>
+    /// Bind to given named pipe.
+    /// </summary>
+    public KestrelConfigurationLoader NamedPipeEndpoint(string pipeName) => NamedPipeEndpoint(pipeName, _ => { });
+
+    /// <summary>
+    /// Bind to given named pipe.
+    /// </summary>
+    public KestrelConfigurationLoader NamedPipeEndpoint(string pipeName, Action<ListenOptions> configure)
+    {
+        ArgumentNullException.ThrowIfNull(pipeName);
+        ArgumentNullException.ThrowIfNull(configure);
+
+        EndpointsToAdd.Add(() =>
+        {
+            Options.ListenNamedPipe(pipeName, configure);
+        });
+
+        return this;
+    }
+
     /// <summary>
     /// Open a socket file descriptor.
     /// </summary>

diff --git a/src/Servers/Kestrel/Core/src/PublicAPI.Unshipped.txt b/src/Servers/Kestrel/Core/src/PublicAPI.Unshipped.txt
@@ -1 +1,3 @@
 #nullable enable
+Microsoft.AspNetCore.Server.Kestrel.KestrelConfigurationLoader.NamedPipeEndpoint(string! pipeName) -> Microsoft.AspNetCore.Server.Kestrel.KestrelConfigurationLoader!
+Microsoft.AspNetCore.Server.Kestrel.KestrelConfigurationLoader.NamedPipeEndpoint(string! pipeName, System.Action<Microsoft.AspNetCore.Server.Kestrel.Core.ListenOptions!>! configure) -> Microsoft.AspNetCore.Server.Kestrel.KestrelConfigurationLoader!
diff --git a/src/Servers/Kestrel/Kestrel/test/KestrelConfigurationLoaderTests.cs b/src/Servers/Kestrel/Kestrel/test/KestrelConfigurationLoaderTests.cs
@@ -1844,6 +1844,23 @@ public void ReloadDoesNotAddEndpoints()
         _ = serverOptions.ConfigurationLoader.Reload();
     }
 
+    [Fact]
+    public void AddNamedPipeEndpoint()
+    {
+        var serverOptions = CreateServerOptions();
+        var builder = serverOptions.Configure()
+            .NamedPipeEndpoint("abc");
+
+        Assert.Empty(serverOptions.GetListenOptions());
+        Assert.Equal(builder, serverOptions.ConfigurationLoader);
+
+        builder.Load();
+
+        Assert.Single(serverOptions.GetListenOptions());
+        Assert.Equal("abc", serverOptions.CodeBackedListenOptions[0].PipeName);
+        Assert.NotNull(serverOptions.ConfigurationLoader);
+    }
+
     private static string GetCertificatePath()
     {
         var appData = Environment.GetEnvironmentVariable("APPDATA");