Package org.terracotta.utilities.test.net

Class PortManager.PortRef

java.lang.Object

org.terracotta.utilities.test.net.PortManager.PortRef

All Implemented Interfaces:

AutoCloseable

Enclosing class:

PortManager

public static class PortManager.PortRef
extends Object
implements AutoCloseable

Represents a reserved TCP port. When use of the port is no longer needed, this reference should be closed to release the reservation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PortManager.PortRef.CloseOption	Options that may be used with close(Set).

Field Summary

Fields

Modifier and Type	Field	Description
private final AtomicBoolean	closed
private final AtomicReference<BiConsumer<Integer,Set<PortManager.PortRef.CloseOption>>>	closers
private final int	port

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PortRef(int port)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this PortRef.
void	close(Set<PortManager.PortRef.CloseOption> options)	Closes this PortRef using the options provided.
private AtomicReference<BiConsumer<Integer,Set<PortManager.PortRef.CloseOption>>>	closers()	Gets the "closers" AtomicReference for use during weak-reference release.
boolean	isClosed()	Returns whether or not this PortRef is closed.
(package private) void	onClose(BiConsumer<Integer,Set<PortManager.PortRef.CloseOption>> action)	Prepends a close action to this PortRef.
int	port()	Gets the reserved port number.

Methods inherited from class java.lang.Object

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

Field Details

port

private final int port

closers

private final AtomicReference<BiConsumer<Integer,Set<PortManager.PortRef.CloseOption>>> closers

closed

private final AtomicBoolean closed

Constructor Details

PortRef

private PortRef(int port)

Method Details

onClose

void onClose(BiConsumer<Integer,Set<PortManager.PortRef.CloseOption>> action)

Prepends a close action to this PortRef. Actions are executed in reverse order of their addition. Each action is passed the port number being closed.

Parameters:

action - the action to take to close this PortRef instance

closers

private AtomicReference<BiConsumer<Integer,Set<PortManager.PortRef.CloseOption>>> closers()

Gets the "closers" AtomicReference for use during weak-reference release.

Returns:

the AtomicReference instance to call for closing this PortRef

port

public int port()

Gets the reserved port number.

Returns:

the port number

isClosed

public boolean isClosed()

Returns whether or not this PortRef is closed.

Returns:

true if this PortRef has been closed; false otherwise

close

public void close()

Closes this PortRef.

Specified by:

close in interface AutoCloseable

close

public void close(Set<PortManager.PortRef.CloseOption> options)

Closes this PortRef using the options provided.

Parameters:

options - the set of PortManager.PortRef.CloseOptions to apply to this close call; may be empty but not null