Package ai.platon.pulsar.common

Object Sockets

  • All Implemented Interfaces:
    
public class Sockets

    Simple utility methods for working with network sockets for example, for finding available ports on localhost.

    Within this class, a TCP port refers to a port for a ServerSocket; whereas, a UDP port refers to a port for a DatagramSocket.

    Since:

    4.0

    Author:

    Sam Brannen

    Ben Hale

    Arjen Poutsma

    Gunnar Hillert

    Gary Russell

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final Integer findAvailableTcpPort(Integer minPort, Integer maxPort) Find an available TCP port randomly selected from the range {@value #PORT_RANGE_MIN}, {@value #PORT_RANGE_MAX}.
      final Integer findAvailableTcpPort(Integer minPort) Find an available TCP port randomly selected from the range {@value #PORT_RANGE_MIN}, {@value #PORT_RANGE_MAX}.
      final Integer findAvailableTcpPort() Find an available TCP port randomly selected from the range {@value #PORT_RANGE_MIN}, {@value #PORT_RANGE_MAX}.
      final SortedSet<Integer> findAvailableTcpPorts(Integer numRequested, Integer minPort, Integer maxPort) Find the requested number of available TCP ports, each randomly selected from the range {@value #PORT_RANGE_MIN}, {@value #PORT_RANGE_MAX}.
      final SortedSet<Integer> findAvailableTcpPorts(Integer numRequested, Integer minPort) Find the requested number of available TCP ports, each randomly selected from the range {@value #PORT_RANGE_MIN}, {@value #PORT_RANGE_MAX}.
      final SortedSet<Integer> findAvailableTcpPorts(Integer numRequested) Find the requested number of available TCP ports, each randomly selected from the range {@value #PORT_RANGE_MIN}, {@value #PORT_RANGE_MAX}.
      final Integer findAvailableUdpPort(Integer minPort, Integer maxPort) Find an available UDP port randomly selected from the range {@value #PORT_RANGE_MIN}, {@value #PORT_RANGE_MAX}.
      final Integer findAvailableUdpPort(Integer minPort) Find an available UDP port randomly selected from the range {@value #PORT_RANGE_MIN}, {@value #PORT_RANGE_MAX}.
      final Integer findAvailableUdpPort() Find an available UDP port randomly selected from the range {@value #PORT_RANGE_MIN}, {@value #PORT_RANGE_MAX}.
      final SortedSet<Integer> findAvailableUdpPorts(Integer numRequested, Integer minPort, Integer maxPort) Find the requested number of available UDP ports, each randomly selected from the range {@value #PORT_RANGE_MIN}, {@value #PORT_RANGE_MAX}.
      final SortedSet<Integer> findAvailableUdpPorts(Integer numRequested, Integer minPort) Find the requested number of available UDP ports, each randomly selected from the range {@value #PORT_RANGE_MIN}, {@value #PORT_RANGE_MAX}.
      final SortedSet<Integer> findAvailableUdpPorts(Integer numRequested) Find the requested number of available UDP ports, each randomly selected from the range {@value #PORT_RANGE_MIN}, {@value #PORT_RANGE_MAX}.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • findAvailableTcpPort

        @JvmOverloads() final Integer findAvailableTcpPort(Integer minPort)

        Find an available TCP port randomly selected from the range {@value #PORT_RANGE_MIN}, {@value #PORT_RANGE_MAX}.

        Returns:

        an available TCP port number

      • findAvailableTcpPort

        @JvmOverloads() final Integer findAvailableTcpPort()

        Find an available TCP port randomly selected from the range {@value #PORT_RANGE_MIN}, {@value #PORT_RANGE_MAX}.

        Returns:

        an available TCP port number

      • findAvailableTcpPorts

        @JvmOverloads() final SortedSet<Integer> findAvailableTcpPorts(Integer numRequested, Integer minPort, Integer maxPort)

        Find the requested number of available TCP ports, each randomly selected from the range {@value #PORT_RANGE_MIN}, {@value #PORT_RANGE_MAX}.

        Parameters:
        numRequested - the number of available ports to find
        Returns:

        a sorted set of available TCP port numbers

      • findAvailableTcpPorts

        @JvmOverloads() final SortedSet<Integer> findAvailableTcpPorts(Integer numRequested, Integer minPort)

        Find the requested number of available TCP ports, each randomly selected from the range {@value #PORT_RANGE_MIN}, {@value #PORT_RANGE_MAX}.

        Parameters:
        numRequested - the number of available ports to find
        Returns:

        a sorted set of available TCP port numbers

      • findAvailableTcpPorts

        @JvmOverloads() final SortedSet<Integer> findAvailableTcpPorts(Integer numRequested)

        Find the requested number of available TCP ports, each randomly selected from the range {@value #PORT_RANGE_MIN}, {@value #PORT_RANGE_MAX}.

        Parameters:
        numRequested - the number of available ports to find
        Returns:

        a sorted set of available TCP port numbers

      • findAvailableUdpPort

        @JvmOverloads() final Integer findAvailableUdpPort(Integer minPort)

        Find an available UDP port randomly selected from the range {@value #PORT_RANGE_MIN}, {@value #PORT_RANGE_MAX}.

        Returns:

        an available UDP port number

      • findAvailableUdpPort

        @JvmOverloads() final Integer findAvailableUdpPort()

        Find an available UDP port randomly selected from the range {@value #PORT_RANGE_MIN}, {@value #PORT_RANGE_MAX}.

        Returns:

        an available UDP port number

      • findAvailableUdpPorts

        @JvmOverloads() final SortedSet<Integer> findAvailableUdpPorts(Integer numRequested, Integer minPort, Integer maxPort)

        Find the requested number of available UDP ports, each randomly selected from the range {@value #PORT_RANGE_MIN}, {@value #PORT_RANGE_MAX}.

        Parameters:
        numRequested - the number of available ports to find
        Returns:

        a sorted set of available UDP port numbers

      • findAvailableUdpPorts

        @JvmOverloads() final SortedSet<Integer> findAvailableUdpPorts(Integer numRequested, Integer minPort)

        Find the requested number of available UDP ports, each randomly selected from the range {@value #PORT_RANGE_MIN}, {@value #PORT_RANGE_MAX}.

        Parameters:
        numRequested - the number of available ports to find
        Returns:

        a sorted set of available UDP port numbers

      • findAvailableUdpPorts

        @JvmOverloads() final SortedSet<Integer> findAvailableUdpPorts(Integer numRequested)

        Find the requested number of available UDP ports, each randomly selected from the range {@value #PORT_RANGE_MIN}, {@value #PORT_RANGE_MAX}.

        Parameters:
        numRequested - the number of available ports to find
        Returns:

        a sorted set of available UDP port numbers