File: NamedPipeEndPoint.cs
Web Access
Project: src\src\Servers\Connections.Abstractions\src\Microsoft.AspNetCore.Connections.Abstractions.csproj (Microsoft.AspNetCore.Connections.Abstractions)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using System.Diagnostics.CodeAnalysis;
using System.Net;
 
namespace Microsoft.AspNetCore.Connections;
 
/// <summary>
/// Represents a Named Pipe endpoint.
/// </summary>
public sealed class NamedPipeEndPoint : EndPoint
{
    internal const string LocalComputerServerName = ".";
 
    /// <summary>
    /// Initializes a new instance of the <see cref="NamedPipeEndPoint"/> class.
    /// </summary>
    /// <param name="pipeName">The name of the pipe.</param>
    public NamedPipeEndPoint(string pipeName) : this(pipeName, LocalComputerServerName)
    {
    }
 
    /// <summary>
    /// Initializes a new instance of the <see cref="NamedPipeEndPoint"/> class.
    /// </summary>
    /// <param name="pipeName">The name of the pipe.</param>
    /// <param name="serverName">The name of the remote computer to connect to, or "." to specify the local computer.</param>
    public NamedPipeEndPoint(string pipeName, string serverName)
    {
        ServerName = serverName;
        PipeName = pipeName;
    }
 
    /// <summary>
    /// Gets the name of the remote computer. The server name must be ".", the local computer, when creating a server.
    /// </summary>
    public string ServerName { get; }
 
    /// <summary>
    /// Gets the name of the pipe.
    /// </summary>
    public string PipeName { get; }
 
    /// <summary>
    /// Gets the pipe name represented by this <see cref="NamedPipeEndPoint"/> instance.
    /// </summary>
    public override string ToString()
    {
        // Based on format at https://learn.microsoft.com/windows/win32/ipc/pipe-names
        return $@"\\{ServerName}\pipe\{PipeName}";
    }
 
    /// <inheritdoc/>
    public override bool Equals([NotNullWhen(true)] object? obj)
    {
        return obj is NamedPipeEndPoint other && other.ServerName == ServerName && other.PipeName == PipeName;
    }
 
    /// <inheritdoc/>
    public override int GetHashCode()
    {
        return ServerName.GetHashCode() ^ PipeName.GetHashCode();
    }
}