在.NET中查找下一个TCP端口


74

我想为WCF服务调用创建一个新的net.tcp:// localhost:x / Service端点,并动态分配新的开放TCP端口。

我知道当我打开到给定服务器的连接时,TcpClient将分配一个新的客户端端口。

是否有一种简单的方法来查找.NET中的下一个打开的TCP端口?

我需要实际的数字,以便可以在上面构建字符串。0不起作用,因为我需要将该字符串传递给另一个进程,以便可以在该新通道上进行回调。


Answers:


136

这是我要找的东西:

static int FreeTcpPort()
{
  TcpListener l = new TcpListener(IPAddress.Loopback, 0);
  l.Start();
  int port = ((IPEndPoint)l.LocalEndpoint).Port;
  l.Stop();
  return port;
}

13
如果另一个进程在重新打开该端口之前打开了该端口,该怎么办?
Mike Christiansen,2009年

6
然后,您当然会得到一个错误,但这对我而言并不是一个问题。
TheSeeker

14
我成功地使用了这种技术来获得免费端口。我也很担心竞争状况,还有其他一些程序潜入并抢占了最近发现的免费端口。所以我写了一个测试用强制Sleep(100)之间var port = FreeTcpPort()的免费端口和启动HttpListener。然后,我循环运行了8个相同的过程。我永远都无法达到比赛条件。我的轶事证据(Win 7)是,操作系统显然会在短暂的端口范围(数千个)中循环,然后再次出现。所以上面的代码片段应该没问题。
Doug Schmidt

3
如果我了解这是如何正常工作的,您是否可以仅执行此操作?TcpListener myActualServer = new TcpListener(ipAddress, 0); myActualServer.Start(); return ((IPEndPoint)myActualServer.LocalEndpoint).Port;或者OP在实际启动其侦听器之前获取端口是否很重要?
JakeStrang

试图使用它来确保无论如何,我们构建服务器上的单元测试都可以通过。但是不。有了这段代码,其中一些甚至无法在我的本地计算机上运行= /
ecth

26

使用端口号0。TCP堆栈将分配下一个空闲端口。


4
那是行不通的,因为我需要实际的#,而不仅仅是0。我需要数字来构建字符串。
TheSeeker

这帮助了我。如果您通知另一端您正在监听的端口,则此方法确实有效。
user35443 2014年

ServiceHost主机=新的ServiceHost(typeof(MyService),新的Uri(“ net.tcp:// localhost:0 / Service”)); 不上班吗
乔尔·麦克贝斯

是的,它有效。您只需要设置endpoint.ListenUriMode为即可Unique
Yegor,2015年

13

该解决方案可与TheSeeker的公认答案相媲美。虽然我认为它更具可读性:

using System;
using System.Net;
using System.Net.Sockets;

    private static readonly IPEndPoint DefaultLoopbackEndpoint = new IPEndPoint(IPAddress.Loopback, port: 0);

    public static int GetAvailablePort()
    {
        using (var socket = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp))
        {
            socket.Bind(DefaultLoopbackEndpoint);
            return ((IPEndPoint)socket.LocalEndPoint).Port;
        }
    }

1
对于UDP,我使用了以下内容:... SocketType.Dgram, ProtocolType.Udp...
BatteryAcid

10

如果您只想提供一个起始端口,并让它返回下一个可用的TCP端口,请使用如下代码:

public static int GetAvailablePort(int startingPort)
{
    var portArray = new List<int>();

    var properties = IPGlobalProperties.GetIPGlobalProperties();

    // Ignore active connections
    var connections = properties.GetActiveTcpConnections();
    portArray.AddRange(from n in connections
                        where n.LocalEndPoint.Port >= startingPort
                        select n.LocalEndPoint.Port);

    // Ignore active tcp listners
    var endPoints = properties.GetActiveTcpListeners();
    portArray.AddRange(from n in endPoints
                        where n.Port >= startingPort
                        select n.Port);

    // Ignore active UDP listeners
    endPoints = properties.GetActiveUdpListeners();
    portArray.AddRange(from n in endPoints
                        where n.Port >= startingPort
                        select n.Port);

    portArray.Sort();

    for (var i = startingPort; i < UInt16.MaxValue; i++)
        if (!portArray.Contains(i))
            return i;

    return 0;
}

完美地工作!
Bestter

请记住,由于某些限制,这在Azure中将不起作用。您将收到拒绝访问。使用netstat也是一样
Samuel Kupferschmid

谢谢,这工作。小补充:您可以删除UDP检查,因为TCP和UDP端口位于单独的名称空间中
3dGrabber

9

首先打开端口,然后将正确的端口号提供给其他进程。

否则,仍然有可能通过其他一些过程首先打开端口,而您仍然拥有另一个端口。


2
您是否有代码示例来尽可能轻松地获得此类tcp端口?
TheSeeker

这是这样做的方法。要小心,如果有多个进程打开同一端口,则可能是竞争条件。
Mike Christiansen,2009年

8

我从Selenium.WebDriver DLL找到了以下代码

命名空间:OpenQA.Selenium.Internal

类别:PortUtility

public static int FindFreePort()
{
    int port = 0;
    Socket socket = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
    try
    {
        IPEndPoint localEP = new IPEndPoint(IPAddress.Any, 0);
        socket.Bind(localEP);
        localEP = (IPEndPoint)socket.LocalEndPoint;
        port = localEP.Port;
    }
    finally
    {
        socket.Close();
    }
    return port;
}

1

如果要获得特定范围内的空闲端口以将其用作本地端口/端点,请执行以下操作:

private int GetFreePortInRange(int PortStartIndex, int PortEndIndex)
{
    DevUtils.LogDebugMessage(string.Format("GetFreePortInRange, PortStartIndex: {0} PortEndIndex: {1}", PortStartIndex, PortEndIndex));
    try
    {
        IPGlobalProperties ipGlobalProperties = IPGlobalProperties.GetIPGlobalProperties();

        IPEndPoint[] tcpEndPoints = ipGlobalProperties.GetActiveTcpListeners();
        List<int> usedServerTCpPorts = tcpEndPoints.Select(p => p.Port).ToList<int>();

        IPEndPoint[] udpEndPoints = ipGlobalProperties.GetActiveUdpListeners();
        List<int> usedServerUdpPorts = udpEndPoints.Select(p => p.Port).ToList<int>();

        TcpConnectionInformation[] tcpConnInfoArray = ipGlobalProperties.GetActiveTcpConnections();
        List<int> usedPorts = tcpConnInfoArray.Where(p=> p.State != TcpState.Closed).Select(p => p.LocalEndPoint.Port).ToList<int>();

        usedPorts.AddRange(usedServerTCpPorts.ToArray());
        usedPorts.AddRange(usedServerUdpPorts.ToArray());

        int unusedPort = 0;

        for (int port = PortStartIndex; port < PortEndIndex; port++)
        {
            if (!usedPorts.Contains(port))
            {
                unusedPort = port;
                break;
            }
        }
        DevUtils.LogDebugMessage(string.Format("Local unused Port:{0}", unusedPort.ToString()));

        if (unusedPort == 0)
        {
            DevUtils.LogErrorMessage("Out of ports");
            throw new ApplicationException("GetFreePortInRange, Out of ports");
        }

        return unusedPort;
    }
    catch (Exception ex)
    {
        string errorMessage = ex.Message;
        DevUtils.LogErrorMessage(errorMessage);
        throw;
    }
}


private int GetLocalFreePort()
{
    int hemoStartLocalPort = int.Parse(DBConfig.GetField("Site.Config.hemoStartLocalPort"));
    int hemoEndLocalPort = int.Parse(DBConfig.GetField("Site.Config.hemoEndLocalPort"));
    int localPort = GetFreePortInRange(hemoStartLocalPort, hemoEndLocalPort);
    DevUtils.LogDebugMessage(string.Format("Local Free Port:{0}", localPort.ToString()));
    return localPort;
}


public void Connect(string host, int port)
{
    try
    {
        // Create socket
        Socket socket = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
        //socket.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.ReuseAddress, true);

        var localPort = GetLocalFreePort();
        // Create an endpoint for the specified IP on any port
        IPEndPoint bindEndPoint = new IPEndPoint(IPAddress.Any, localPort);

        // Bind the socket to the endpoint
        socket.Bind(bindEndPoint);

        // Connect to host
        socket.Connect(IPAddress.Parse(host), port);

        socket.Dispose();
    }
    catch (SocketException ex)
    {
        // Get the error message
        string errorMessage = ex.Message;
        DevUtils.LogErrorMessage(errorMessage);
    }
}


public void Connect2(string host, int port)
{
    try
    {
        // Create socket

        var localPort = GetLocalFreePort();

        // Create an endpoint for the specified IP on any port
        IPEndPoint bindEndPoint = new IPEndPoint(IPAddress.Any, localPort);

        var client = new TcpClient(bindEndPoint);
        //client.Client.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.ReuseAddress, true); //will release port when done

        // Connect to the host
        client.Connect(IPAddress.Parse(host), port);

        client.Close();
    }
    catch (SocketException ex)
    {
        // Get the error message
        string errorMessage = ex.Message;
        DevUtils.LogErrorMessage(errorMessage);
    }
}

1

如果要在给定范围内找到下一个可用的TCP端口,这是一种简化的实现方法:

private int GetNextUnusedPort(int min, int max)
{
    if (max < min)
        throw new ArgumentException("Max cannot be less than min.");

    var ipProperties = IPGlobalProperties.GetIPGlobalProperties();

    var usedPorts =
        ipProperties.GetActiveTcpConnections()
            .Where(connection => connection.State != TcpState.Closed)
            .Select(connection => connection.LocalEndPoint)
            .Concat(ipProperties.GetActiveTcpListeners())
            .Concat(ipProperties.GetActiveUdpListeners())
            .Select(endpoint => endpoint.Port)
            .ToArray();

    var firstUnused =
        Enumerable.Range(min, max - min)
            .Where(port => !usedPorts.Contains(port))
            .Select(port => new int?(port))
            .FirstOrDefault();

    if (!firstUnused.HasValue)
        throw new Exception($"All local TCP ports between {min} and {max} are currently in use.");

    return firstUnused.Value;
}
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.