Package org.elasticsearch.transport

Class TcpTransport

java.lang.Object

org.elasticsearch.common.component.AbstractLifecycleComponent

org.elasticsearch.transport.TcpTransport

All Implemented Interfaces:

Closeable, AutoCloseable, LifecycleComponent, Releasable, Transport

public abstract class TcpTransport
extends AbstractLifecycleComponent
implements Transport

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TcpTransport.HttpRequestOnTransportException	A helper exception to mark an incoming connection as potentially being HTTP so an appropriate error code can be returned
final class	TcpTransport.NodeChannels
static final class	TcpTransport.ProfileSettings	Representation of a transport profile settings for a transport.profiles.$profilename.*

Nested classes/interfaces inherited from interface org.elasticsearch.transport.Transport

Transport.Connection, Transport.RequestHandlers, Transport.ResponseContext<T extends TransportResponse>, Transport.ResponseHandlers

Field Summary

Fields

Modifier and Type	Field	Description
protected final NetworkService	networkService
protected final PageCacheRecycler	pageCacheRecycler
protected final Set<TcpTransport.ProfileSettings>	profileSettingsSet
protected final Settings	settings
protected final ThreadPool	threadPool
static final String	TRANSPORT_WORKER_THREAD_NAME_PREFIX

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

lifecycle

Constructor Summary

Constructors

Constructor	Description
TcpTransport(Settings settings, Version version, ThreadPool threadPool, PageCacheRecycler pageCacheRecycler, CircuitBreakerService circuitBreakerService, NamedWriteableRegistry namedWriteableRegistry, NetworkService networkService)

Method Summary

Modifier and Type	Method	Description
TransportAddress[]	addressesFromString(String address)	Returns an address from its string representation.
protected abstract TcpServerChannel	bind(String name, InetSocketAddress address)	Binds to the given InetSocketAddress
protected void	bindServer(TcpTransport.ProfileSettings profileSettings)
BoundTransportAddress	boundAddress()	The address the transport is bound on.
protected final void	doClose()
protected final void	doStop()
void	executeHandshake(DiscoveryNode node, TcpChannel channel, ConnectionProfile profile, ActionListener<Version> listener)
List<String>	getDefaultSeedAddresses()	Returns a list of all local addresses for this transport
Supplier<CircuitBreaker>	getInflightBreaker()
static Set<TcpTransport.ProfileSettings>	getProfileSettings(Settings settings)	Returns all profile settings for the given settings object
final Transport.RequestHandlers	getRequestHandlers()
final Transport.ResponseHandlers	getResponseHandlers()
final TransportStats	getStats()
StatsTracker	getStatsTracker()
ThreadPool	getThreadPool()
Version	getVersion()
void	inboundMessage(TcpChannel channel, InboundMessage message)	Handles inbound message that has been decoded.
protected abstract TcpChannel	initiateChannel(DiscoveryNode node)	Initiate a single tcp socket channel.
protected ConnectionProfile	maybeOverrideConnectionProfile(ConnectionProfile connectionProfile)
void	onException(TcpChannel channel, Exception e)
protected void	onServerException(TcpServerChannel channel, Exception e)
void	openConnection(DiscoveryNode node, ConnectionProfile profile, ActionListener<Transport.Connection> listener)	Opens a new connection to the given node.
Map<String,BoundTransportAddress>	profileBoundAddresses()	Further profile bound addresses
static int	readMessageLength(BytesReference networkBytes)	Validates the first 6 bytes of the message header and returns the length of the message.
protected void	serverAcceptedChannel(TcpChannel channel)
void	setMessageListener(TransportMessageListener listener)
void	setSlowLogThreshold(TimeValue slowLogThreshold)
protected abstract void	stopInternal()	Called to tear down internal resources

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

addLifecycleListener, close, doStart, lifecycleState, removeLifecycleListener, start, stop

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.core.Releasable

close

Methods inherited from interface org.elasticsearch.transport.Transport

isSecure, registerRequestHandler

Field Details

TRANSPORT_WORKER_THREAD_NAME_PREFIX

public static final String TRANSPORT_WORKER_THREAD_NAME_PREFIX

See Also:

• Constant Field Values

settings

protected final Settings settings

threadPool

protected final ThreadPool threadPool

pageCacheRecycler

protected final PageCacheRecycler pageCacheRecycler

networkService

protected final NetworkService networkService

profileSettingsSet

protected final Set<TcpTransport.ProfileSettings> profileSettingsSet

Constructor Details

TcpTransport

public TcpTransport(Settings settings,
 Version version,
 ThreadPool threadPool,
 PageCacheRecycler pageCacheRecycler,
 CircuitBreakerService circuitBreakerService,
 NamedWriteableRegistry namedWriteableRegistry,
 NetworkService networkService)

Method Details

getVersion

public Version getVersion()

getStatsTracker

public StatsTracker getStatsTracker()

getThreadPool

public ThreadPool getThreadPool()

getInflightBreaker

public Supplier<CircuitBreaker> getInflightBreaker()

setMessageListener

public void setMessageListener(TransportMessageListener listener)

Specified by:

setMessageListener in interface Transport

setSlowLogThreshold

public void setSlowLogThreshold(TimeValue slowLogThreshold)

Specified by:

setSlowLogThreshold in interface Transport

maybeOverrideConnectionProfile

protected ConnectionProfile maybeOverrideConnectionProfile(ConnectionProfile connectionProfile)

openConnection

public void openConnection(DiscoveryNode node,
 ConnectionProfile profile,
 ActionListener<Transport.Connection> listener)

Description copied from interface: Transport

Opens a new connection to the given node. When the connection is fully connected, the listener is called. The ActionListener will be called on the calling thread or the generic thread pool.

Specified by:

openConnection in interface Transport

boundAddress

public BoundTransportAddress boundAddress()

Description copied from interface: Transport

The address the transport is bound on.

Specified by:

boundAddress in interface Transport

profileBoundAddresses

public Map<String,BoundTransportAddress> profileBoundAddresses()

Description copied from interface: Transport

Further profile bound addresses

Specified by:

profileBoundAddresses in interface Transport

Returns:

null iff profiles are unsupported, otherwise a map with name of profile and its bound transport address

getDefaultSeedAddresses

public List<String> getDefaultSeedAddresses()

Description copied from interface: Transport

Returns a list of all local addresses for this transport

Specified by:

getDefaultSeedAddresses in interface Transport

bindServer

protected void bindServer(TcpTransport.ProfileSettings profileSettings)

addressesFromString

public TransportAddress[] addressesFromString(String address)
                                       throws UnknownHostException

Description copied from interface: Transport

Returns an address from its string representation.

Specified by:

addressesFromString in interface Transport

Throws:

UnknownHostException

doClose

protected final void doClose()

Specified by:

doClose in class AbstractLifecycleComponent

doStop

protected final void doStop()

Specified by:

doStop in class AbstractLifecycleComponent

onException

public void onException(TcpChannel channel,
 Exception e)

onServerException

protected void onServerException(TcpServerChannel channel,
 Exception e)

serverAcceptedChannel

protected void serverAcceptedChannel(TcpChannel channel)

bind

protected abstract TcpServerChannel bind(String name,
 InetSocketAddress address)
                                  throws IOException

Binds to the given InetSocketAddress

Parameters:

name - the profile name

address - the address to bind to

Throws:

IOException

initiateChannel

protected abstract TcpChannel initiateChannel(DiscoveryNode node)
                                       throws IOException

Initiate a single tcp socket channel.

Parameters:

node - for the initiated connection

Returns:

the pending connection

Throws:

IOException - if an I/O exception occurs while opening the channel

stopInternal

protected abstract void stopInternal()

Called to tear down internal resources

inboundMessage

public void inboundMessage(TcpChannel channel,
 InboundMessage message)

Handles inbound message that has been decoded.

Parameters:

channel - the channel the message is from

message - the message

readMessageLength

public static int readMessageLength(BytesReference networkBytes)
                             throws IOException

Validates the first 6 bytes of the message header and returns the length of the message. If 6 bytes are not available, it returns -1.

Parameters:

networkBytes - the will be read

Returns:

the length of the message

Throws:

StreamCorruptedException - if the message header format is not recognized

TcpTransport.HttpRequestOnTransportException - if the message header appears to be an HTTP message

IllegalArgumentException - if the message length is greater that the maximum allowed frame size. This is dependent on the available memory.

IOException

executeHandshake

public void executeHandshake(DiscoveryNode node,
 TcpChannel channel,
 ConnectionProfile profile,
 ActionListener<Version> listener)

getStats

public final TransportStats getStats()

Specified by:

getStats in interface Transport

getProfileSettings

public static Set<TcpTransport.ProfileSettings> getProfileSettings(Settings settings)

Returns all profile settings for the given settings object

getResponseHandlers

public final Transport.ResponseHandlers getResponseHandlers()

Specified by:

getResponseHandlers in interface Transport

getRequestHandlers

public final Transport.RequestHandlers getRequestHandlers()

Specified by:

getRequestHandlers in interface Transport