org.apache.brooklyn.util.net

Class ReachableSocketFinder

java.lang.Object

org.apache.brooklyn.util.net.ReachableSocketFinder

public class ReachableSocketFinder
extends java.lang.Object

For finding an open/reachable ip:port for a node.

Constructor Summary

Constructors

Constructor and Description
ReachableSocketFinder()
ReachableSocketFinder(com.google.common.base.Predicate<? super com.google.common.net.HostAndPort> socketTester)
ReachableSocketFinder(com.google.common.base.Predicate<? super com.google.common.net.HostAndPort> socketTester, Duration gracePeriod)

Method Summary

Modifier and Type	Method and Description
com.google.common.net.HostAndPort	findOpenSocketOnNode(java.lang.Iterable<? extends com.google.common.net.HostAndPort> sockets, Duration timeout) Returns the first element of sockets that is reachable.
java.lang.Iterable<com.google.common.net.HostAndPort>	findOpenSocketsOnNode(java.lang.Iterable<? extends com.google.common.net.HostAndPort> sockets, Duration timeout) Returns an iterable of the elements in sockets that are reachable.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReachableSocketFinder

public ReachableSocketFinder()

ReachableSocketFinder

public ReachableSocketFinder(com.google.common.base.Predicate<? super com.google.common.net.HostAndPort> socketTester)

ReachableSocketFinder

public ReachableSocketFinder(com.google.common.base.Predicate<? super com.google.common.net.HostAndPort> socketTester,
                             Duration gracePeriod)

Parameters:

socketTester - A predicate that determines the reachability of a host and port

gracePeriod - The duration to allow remaining checks to continue after a socket is reached for the first time.

Method Detail

findOpenSocketOnNode

public com.google.common.net.HostAndPort findOpenSocketOnNode(java.lang.Iterable<? extends com.google.common.net.HostAndPort> sockets,
                                                              Duration timeout)

Returns the first element of sockets that is reachable.

Parameters:

sockets - The host-and-ports to test

timeout - Max time to try to connect to the ip:port

Returns:

The reachable ip:port

Throws:

java.util.NoSuchElementException - If no ports are accessible within the given time

java.lang.NullPointerException - If sockets or timeout is null

java.lang.IllegalStateException - If the sockets to test is empty

findOpenSocketsOnNode

public java.lang.Iterable<com.google.common.net.HostAndPort> findOpenSocketsOnNode(java.lang.Iterable<? extends com.google.common.net.HostAndPort> sockets,
                                                                                   Duration timeout)

Returns an iterable of the elements in sockets that are reachable. The order of elements in the iterable corresponds to the order of the elements in the input, not the order in which their reachability was determined. Iterators are unmodifiable.

Parameters:

sockets - The host-and-ports to test

timeout - Max time to try to connect to each ip:port

Returns:

An iterable containing all sockets that are reachable according to socketTester.

Throws:

java.lang.NullPointerException - If sockets or timeout is null

java.lang.IllegalStateException - If the sockets to test is empty