Class SocketUtil


  • public class SocketUtil
    extends java.lang.Object
    Utility class to find a port to debug on.
    Restriction:
    This class is not intended to be subclassed by clients.
    Restriction:
    This class is not intended to be instantiated by clients.
    • Constructor Summary

      Constructors 
      Constructor Description
      SocketUtil()  
    • Method Summary

      All Methods Static Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static int findFreePort()
      Returns a free port number on localhost, or -1 if unable to find a free port.
      static int findUnusedLocalPort​(java.lang.String host, int searchFrom, int searchTo)
      Deprecated.
      Use findFreePort() instead.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • SocketUtil

        public SocketUtil()
    • Method Detail

      • findUnusedLocalPort

        @Deprecated
        public static int findUnusedLocalPort​(java.lang.String host,
                                              int searchFrom,
                                              int searchTo)
        Deprecated.
        Use findFreePort() instead. It is possible that this method can return a port that is already in use since the implementation does not bind to the given port to ensure that it is free.
        Returns a free port number on the specified host within the given range, or -1 if none found.
        Parameters:
        host - name or IP address of host on which to find a free port
        searchFrom - the port number from which to start searching
        searchTo - the port number at which to stop searching
        Returns:
        a free port in the specified range, or -1 of none found
      • findFreePort

        public static int findFreePort()
        Returns a free port number on localhost, or -1 if unable to find a free port.
        Returns:
        a free port number on localhost, or -1 if unable to find a free port
        Since:
        3.0