org.gradle.util

Class AvailablePortFinder

java.lang.Object

org.gradle.util.AvailablePortFinder

@ThreadSafe
public class AvailablePortFinder
extends Object

Finds currently available server ports within a certain port range. Code originally taken from Apache MINA. Note: If possible, it's preferable to let the party creating the server socket select the port (e.g. with new ServerSocket(0)) and then query it for the port chosen. With this class, there is always a risk that someone else grabs the port between the time it is returned from getNextAvailable() and the time the socket is created.

Author:

Apache MINA Project

See Also:

IANA.org

Constructor Summary

Constructors

Constructor and Description
AvailablePortFinder()

Method Summary

Methods

Modifier and Type	Method and Description
static AvailablePortFinder	createPrivate() Creates a port finder that operates on private ports.
int	getNextAvailable() Gets the next available port.

Methods inherited from class java.lang.Object

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

Constructor Detail

AvailablePortFinder

public AvailablePortFinder()

Method Detail

createPrivate

public static AvailablePortFinder createPrivate()

Creates a port finder that operates on private ports.

Returns:

a port finder that operates on private ports

getNextAvailable

public int getNextAvailable()

Gets the next available port.

Tries to avoid returning the same port on successive invocations (but it may happen if no other available ports are found).

Returns:

the next available port

Throws:

NoSuchElementException - if no available port is found