org.elasticsearch.discovery.zen.ping.unicast

Class UnicastZenPing

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.common.component.AbstractLifecycleComponent<ZenPing>

org.elasticsearch.discovery.zen.ping.unicast.UnicastZenPing

All Implemented Interfaces:

AutoCloseable, LifecycleComponent<ZenPing>, Releasable, ZenPing

public class UnicastZenPing
extends AbstractLifecycleComponent<ZenPing>
implements ZenPing

Nested Class Summary

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

ZenPing.PingCollection, ZenPing.PingListener, ZenPing.PingResponse

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_NAME
static String	ACTION_NAME_GTE_1_4 when pinging the initial configured target hosts, we do not know their version.
static int	LIMIT_PORTS_COUNT

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

lifecycle

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

componentSettings, logger, settings

Constructor Summary

Constructors

Constructor and Description
UnicastZenPing(Settings settings, ThreadPool threadPool, TransportService transportService, ClusterName clusterName, Version version, ElectMasterService electMasterService, Set<UnicastHostsProvider> unicastHostsProviders)

Method Summary

Modifier and Type	Method and Description
void	addHostsProvider(UnicastHostsProvider provider)
void	clearTemporalResponses() Clears the list of cached ping responses.
protected void	doClose()
protected void	doStart()
protected void	doStop()
void	ping(ZenPing.PingListener listener, TimeValue timeout)
ZenPing.PingResponse[]	pingAndWait(TimeValue timeout)
void	removeHostsProvider(UnicastHostsProvider provider)
void	setPingContextProvider(PingContextProvider contextProvider)

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

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

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

nodeName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.component.LifecycleComponent

addLifecycleListener, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from interface org.elasticsearch.common.lease.Releasable

close

Field Detail

ACTION_NAME

public static final String ACTION_NAME

See Also:

Constant Field Values

ACTION_NAME_GTE_1_4

public static final String ACTION_NAME_GTE_1_4

when pinging the initial configured target hosts, we do not know their version. We therefore use the lowest possible version (i.e., 1.0.0) for serializing information on the wire. As of 1.4, we needed to extend the information sent in a ping, to prefer nodes which have previously joined the cluster during master election. This information is only needed if all the cluster is on version 1.4 or up. To bypass this issue we introduce a second action name which is guaranteed to exist only on nodes from version 1.4.0 and up. Using this action, we can safely use 1.4.0 as a serialization format. If this fails with a ActionNotFoundTransportException we know we speak to a node with <1.4 version, and fall back to use ACTION_NAME.

See Also:

Constant Field Values

LIMIT_PORTS_COUNT

public static final int LIMIT_PORTS_COUNT

See Also:

Constant Field Values

Constructor Detail

UnicastZenPing

public UnicastZenPing(Settings settings,
                      ThreadPool threadPool,
                      TransportService transportService,
                      ClusterName clusterName,
                      Version version,
                      ElectMasterService electMasterService,
                      @Nullable
                      Set<UnicastHostsProvider> unicastHostsProviders)

Method Detail

doStart

protected void doStart()
                throws ElasticsearchException

Specified by:

doStart in class AbstractLifecycleComponent<ZenPing>

Throws:

ElasticsearchException

doStop

protected void doStop()
               throws ElasticsearchException

Specified by:

doStop in class AbstractLifecycleComponent<ZenPing>

Throws:

ElasticsearchException

doClose

protected void doClose()
                throws ElasticsearchException

Specified by:

doClose in class AbstractLifecycleComponent<ZenPing>

Throws:

ElasticsearchException

addHostsProvider

public void addHostsProvider(UnicastHostsProvider provider)

removeHostsProvider

public void removeHostsProvider(UnicastHostsProvider provider)

setPingContextProvider

public void setPingContextProvider(PingContextProvider contextProvider)

Specified by:

setPingContextProvider in interface ZenPing

clearTemporalResponses

public void clearTemporalResponses()

Clears the list of cached ping responses.

pingAndWait

public ZenPing.PingResponse[] pingAndWait(TimeValue timeout)

ping

public void ping(ZenPing.PingListener listener,
                 TimeValue timeout)
          throws ElasticsearchException

Specified by:

ping in interface ZenPing

Throws:

ElasticsearchException