org.elasticsearch.discovery.zen

Class UnicastZenPing

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.discovery.zen.UnicastZenPing

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Releasable, ZenPing

public class UnicastZenPing
extends AbstractComponent
implements ZenPing

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	UnicastZenPing.PingingRound
static class	UnicastZenPing.UnicastPingRequest

Nested classes/interfaces inherited from interface org.elasticsearch.discovery.zen.ZenPing

ZenPing.PingCollection, ZenPing.PingResponse

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_NAME
static Setting<java.lang.Integer>	DISCOVERY_ZEN_PING_UNICAST_CONCURRENT_CONNECTS_SETTING
static Setting<TimeValue>	DISCOVERY_ZEN_PING_UNICAST_HOSTS_RESOLVE_TIMEOUT
static Setting<java.util.List<java.lang.String>>	DISCOVERY_ZEN_PING_UNICAST_HOSTS_SETTING
static int	LIMIT_FOREIGN_PORTS_COUNT
static int	LIMIT_LOCAL_PORTS_COUNT
protected EsThreadPoolExecutor	unicastZenPingExecutorService

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
UnicastZenPing(Settings settings, ThreadPool threadPool, TransportService transportService, UnicastHostsProvider unicastHostsProvider)

Method Summary

Modifier and Type	Method and Description
void	clearTemporalResponses() Clears the list of cached ping responses.
void	close()
protected void	finishPingingRound(UnicastZenPing.PingingRound pingingRound)
protected TransportResponseHandler<org.elasticsearch.discovery.zen.UnicastZenPing.UnicastPingResponse>	getPingResponseHandler(UnicastZenPing.PingingRound pingingRound, DiscoveryNode node)
protected Version	getVersion()
void	ping(java.util.function.Consumer<ZenPing.PingCollection> resultsConsumer, TimeValue duration) Sends three rounds of pings notifying the specified Consumer when pinging is complete.
protected void	ping(java.util.function.Consumer<ZenPing.PingCollection> resultsConsumer, TimeValue scheduleDuration, TimeValue requestDuration) a variant of ping(Consumer, TimeValue), but allows separating the scheduling duration from the duration used for request level time outs.
static java.util.List<DiscoveryNode>	resolveHostsLists(java.util.concurrent.ExecutorService executorService, org.apache.logging.log4j.Logger logger, java.util.List<java.lang.String> hosts, int limitPortCounts, TransportService transportService, java.lang.String nodeId_prefix, TimeValue resolveTimeout) Resolves a list of hosts to a list of discovery nodes.
protected void	sendPings(TimeValue timeout, UnicastZenPing.PingingRound pingingRound)
void	start(PingContextProvider contextProvider)
protected void	submitToExecutor(AbstractRunnable abstractRunnable)

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_NAME

public static final java.lang.String ACTION_NAME

See Also:

Constant Field Values

DISCOVERY_ZEN_PING_UNICAST_HOSTS_SETTING

public static final Setting<java.util.List<java.lang.String>> DISCOVERY_ZEN_PING_UNICAST_HOSTS_SETTING

DISCOVERY_ZEN_PING_UNICAST_CONCURRENT_CONNECTS_SETTING

public static final Setting<java.lang.Integer> DISCOVERY_ZEN_PING_UNICAST_CONCURRENT_CONNECTS_SETTING

DISCOVERY_ZEN_PING_UNICAST_HOSTS_RESOLVE_TIMEOUT

public static final Setting<TimeValue> DISCOVERY_ZEN_PING_UNICAST_HOSTS_RESOLVE_TIMEOUT

LIMIT_FOREIGN_PORTS_COUNT

public static final int LIMIT_FOREIGN_PORTS_COUNT

See Also:

Constant Field Values

LIMIT_LOCAL_PORTS_COUNT

public static final int LIMIT_LOCAL_PORTS_COUNT

See Also:

Constant Field Values

unicastZenPingExecutorService

protected final EsThreadPoolExecutor unicastZenPingExecutorService

Constructor Detail

UnicastZenPing

public UnicastZenPing(Settings settings,
                      ThreadPool threadPool,
                      TransportService transportService,
                      UnicastHostsProvider unicastHostsProvider)

Method Detail

resolveHostsLists

public static java.util.List<DiscoveryNode> resolveHostsLists(java.util.concurrent.ExecutorService executorService,
                                                              org.apache.logging.log4j.Logger logger,
                                                              java.util.List<java.lang.String> hosts,
                                                              int limitPortCounts,
                                                              TransportService transportService,
                                                              java.lang.String nodeId_prefix,
                                                              TimeValue resolveTimeout)
                                                       throws java.lang.InterruptedException

Resolves a list of hosts to a list of discovery nodes. Each host is resolved into a transport address (or a collection of addresses if the number of ports is greater than one) and the transport addresses are used to created discovery nodes. Host lookups are done in parallel using specified executor service up to the specified resolve timeout.

Parameters:

executorService - the executor service used to parallelize hostname lookups

logger - logger used for logging messages regarding hostname lookups

hosts - the hosts to resolve

limitPortCounts - the number of ports to resolve (should be 1 for non-local transport)

transportService - the transport service

nodeId_prefix - a prefix to use for node ids

resolveTimeout - the timeout before returning from hostname lookups

Returns:

a list of discovery nodes with resolved transport addresses

Throws:

java.lang.InterruptedException

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface Releasable

start

public void start(PingContextProvider contextProvider)

Specified by:

start in interface ZenPing

clearTemporalResponses

public void clearTemporalResponses()

Clears the list of cached ping responses.

ping

public void ping(java.util.function.Consumer<ZenPing.PingCollection> resultsConsumer,
                 TimeValue duration)

Sends three rounds of pings notifying the specified Consumer when pinging is complete. Pings are sent after resolving configured unicast hosts to their IP address (subject to DNS caching within the JVM). A batch of pings is sent, then another batch of pings is sent at half the specified TimeValue, and then another batch of pings is sent at the specified TimeValue. The pings that are sent carry a timeout of 1.25 times the specified TimeValue. When pinging each node, a connection and handshake is performed, with a connection timeout of the specified TimeValue.

Specified by:

ping in interface ZenPing

Parameters:

resultsConsumer - the callback when pinging is complete

duration - the timeout for various components of the pings

ping

protected void ping(java.util.function.Consumer<ZenPing.PingCollection> resultsConsumer,
                    TimeValue scheduleDuration,
                    TimeValue requestDuration)

a variant of ping(Consumer, TimeValue), but allows separating the scheduling duration from the duration used for request level time outs. This is useful for testing

finishPingingRound

protected void finishPingingRound(UnicastZenPing.PingingRound pingingRound)

sendPings

protected void sendPings(TimeValue timeout,
                         UnicastZenPing.PingingRound pingingRound)

submitToExecutor

protected void submitToExecutor(AbstractRunnable abstractRunnable)

getPingResponseHandler

protected TransportResponseHandler<org.elasticsearch.discovery.zen.UnicastZenPing.UnicastPingResponse> getPingResponseHandler(UnicastZenPing.PingingRound pingingRound,
                                                                                                                              DiscoveryNode node)

getVersion

protected Version getVersion()