org.elasticsearch.transport

Class TcpTransport

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.common.component.AbstractLifecycleComponent

org.elasticsearch.transport.TcpTransport

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, LifecycleComponent, Releasable, Transport

public abstract class TcpTransport
extends AbstractLifecycleComponent
implements Transport

Nested Class Summary

Nested Classes

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

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

Transport.Connection

Field Summary

Fields

Modifier and Type	Field and Description
static Setting<java.util.List<java.lang.String>>	BIND_HOST
static Setting.AffixSetting<java.util.List<java.lang.String>>	BIND_HOST_PROFILE
protected BoundTransportAddress	boundAddress
protected java.util.concurrent.locks.ReadWriteLock	closeLock
protected boolean	compress
protected java.util.concurrent.ConcurrentMap<DiscoveryNode,TcpTransport.NodeChannels>	connectedNodes
protected KeyedLock<java.lang.String>	connectionLock
static Setting<java.lang.Integer>	CONNECTIONS_PER_NODE_BULK
static Setting<java.lang.Integer>	CONNECTIONS_PER_NODE_PING
static Setting<java.lang.Integer>	CONNECTIONS_PER_NODE_RECOVERY
static Setting<java.lang.Integer>	CONNECTIONS_PER_NODE_REG
static Setting<java.lang.Integer>	CONNECTIONS_PER_NODE_STATE
static java.lang.String	DEFAULT_PROFILE
protected ConnectionProfile	defaultConnectionProfile
static Setting<java.util.List<java.lang.String>>	HOST
protected NetworkService	networkService
static int	PING_DATA_SIZE
static Setting<TimeValue>	PING_SCHEDULE
static Setting<java.lang.String>	PORT
static Setting.AffixSetting<java.lang.String>	PORT_PROFILE
protected java.util.concurrent.ConcurrentMap<java.lang.String,BoundTransportAddress>	profileBoundAddresses
protected java.util.Set<TcpTransport.ProfileSettings>	profileSettings
static Setting<java.util.List<java.lang.String>>	PUBLISH_HOST
static Setting.AffixSetting<java.util.List<java.lang.String>>	PUBLISH_HOST_PROFILE
static Setting<java.lang.Integer>	PUBLISH_PORT
static Setting.AffixSetting<java.lang.Integer>	PUBLISH_PORT_PROFILE
protected TcpTransport.ScheduledPing	scheduledPing
static Setting<TimeValue>	TCP_CONNECT_TIMEOUT
static Setting<java.lang.Boolean>	TCP_KEEP_ALIVE
static Setting.AffixSetting<java.lang.Boolean>	TCP_KEEP_ALIVE_PROFILE
static Setting<java.lang.Boolean>	TCP_NO_DELAY
static Setting.AffixSetting<java.lang.Boolean>	TCP_NO_DELAY_PROFILE
static Setting<ByteSizeValue>	TCP_RECEIVE_BUFFER_SIZE
static Setting.AffixSetting<ByteSizeValue>	TCP_RECEIVE_BUFFER_SIZE_PROFILE
static Setting<java.lang.Boolean>	TCP_REUSE_ADDRESS
static Setting.AffixSetting<java.lang.Boolean>	TCP_REUSE_ADDRESS_PROFILE
static Setting<ByteSizeValue>	TCP_SEND_BUFFER_SIZE
static Setting.AffixSetting<ByteSizeValue>	TCP_SEND_BUFFER_SIZE_PROFILE
protected ThreadPool	threadPool
static java.lang.String	TRANSPORT_CLIENT_BOSS_THREAD_NAME_PREFIX
static java.lang.String	TRANSPORT_SERVER_WORKER_THREAD_NAME_PREFIX
protected TransportService	transportService

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

lifecycle

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

deprecationLogger, logger, settings

Fields inherited from interface org.elasticsearch.transport.Transport

TRANSPORT_TCP_COMPRESS

Constructor Summary

Constructors

Constructor and Description
TcpTransport(java.lang.String transportName, Settings settings, ThreadPool threadPool, BigArrays bigArrays, CircuitBreakerService circuitBreakerService, NamedWriteableRegistry namedWriteableRegistry, NetworkService networkService)

Method Summary

Modifier and Type	Method and Description
TransportAddress[]	addressesFromString(java.lang.String address, int perAddressLimit) Returns an address from its string representation.
protected abstract TcpChannel	bind(java.lang.String name, java.net.InetSocketAddress address) Binds to the given InetSocketAddress
protected void	bindServer(TcpTransport.ProfileSettings profileSettings)
protected java.net.InetSocketAddress	bindToPort(java.lang.String name, java.net.InetAddress hostAddress, java.lang.String port)
BoundTransportAddress	boundAddress() The address the transport is bound on.
boolean	canCompress(TransportRequest request)
void	connectToNode(DiscoveryNode node, ConnectionProfile connectionProfile, CheckedBiConsumer<Transport.Connection,ConnectionProfile,java.io.IOException> connectionValidator) Connects to a node with the given connection profile.
void	disconnectFromNode(DiscoveryNode node) Disconnected from the given node, if not connected, will do nothing.
protected void	doClose()
protected void	doStart()
protected void	doStop()
protected void	ensureOpen() Ensures this transport is still started / open
protected Version	executeHandshake(DiscoveryNode node, TcpChannel channel, TimeValue timeout)
TcpTransport.NodeChannels	getConnection(DiscoveryNode node) Returns a connection for the given node if the node is connected.
protected Version	getCurrentVersion()
CircuitBreaker	getInFlightRequestBreaker()
java.util.List<java.lang.String>	getLocalAddresses()
protected abstract long	getNumOpenServerConnections() Returns count of currently open connections
static java.util.Set<TcpTransport.ProfileSettings>	getProfileSettings(Settings settings) Returns all profile settings for the given settings object
TransportStats	getStats()
protected java.lang.String	handleRequest(TcpChannel channel, java.lang.String profileName, StreamInput stream, long requestId, int messageLengthBytes, Version version, java.net.InetSocketAddress remoteAddress, byte status)
protected abstract TcpChannel	initiateChannel(DiscoveryNode node, TimeValue connectTimeout, ActionListener<java.lang.Void> connectListener) Initiate a single tcp socket channel to a node.
void	messageReceived(BytesReference reference, TcpChannel channel, java.lang.String profileName, java.net.InetSocketAddress remoteAddress, int messageLengthBytes) This method handles the message receive part for both request and responses
long	newRequestId() Returns a new request ID to use when sending a message via Transport.Connection.sendRequest(long, String, TransportRequest, TransportRequestOptions)
boolean	nodeConnected(DiscoveryNode node) Returns true if the node is connected.
protected void	onException(TcpChannel channel, java.lang.Exception e)
TcpTransport.NodeChannels	openConnection(DiscoveryNode node, ConnectionProfile connectionProfile) Opens a new connection to the given node and returns it.
java.util.Map<java.lang.String,BoundTransportAddress>	profileBoundAddresses() Further profile bound addresses
protected ConnectionProfile	resolveConnectionProfile(ConnectionProfile connectionProfile)
static int	resolvePublishPort(TcpTransport.ProfileSettings profileSettings, java.util.List<java.net.InetSocketAddress> boundAddresses, java.net.InetAddress publishInetAddress)
void	sendErrorResponse(Version nodeVersion, TcpChannel channel, java.lang.Exception error, long requestId, java.lang.String action) Sends back an error response to the caller via the given channel
void	sendResponse(Version nodeVersion, TcpChannel channel, TransportResponse response, long requestId, java.lang.String action, TransportResponseOptions options) Sends the response to the given channel.
protected void	serverAcceptedChannel(TcpChannel channel)
void	setTransportService(TransportService service)
protected void	stopInternal() Called to tear down internal resources
static boolean	validateMessageHeader(BytesReference buffer) Validates the first N bytes of the message header and returns false if the message is a ping message and has no payload ie.
protected void	validateRequest(StreamInput stream, long requestId, java.lang.String action)

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

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

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

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

TRANSPORT_SERVER_WORKER_THREAD_NAME_PREFIX

public static final java.lang.String TRANSPORT_SERVER_WORKER_THREAD_NAME_PREFIX

See Also:

Constant Field Values

TRANSPORT_CLIENT_BOSS_THREAD_NAME_PREFIX

public static final java.lang.String TRANSPORT_CLIENT_BOSS_THREAD_NAME_PREFIX

See Also:

Constant Field Values

HOST

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

BIND_HOST

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

PUBLISH_HOST

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

PORT

public static final Setting<java.lang.String> PORT

PUBLISH_PORT

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

DEFAULT_PROFILE

public static final java.lang.String DEFAULT_PROFILE

See Also:

Constant Field Values

PING_SCHEDULE

public static final Setting<TimeValue> PING_SCHEDULE

CONNECTIONS_PER_NODE_RECOVERY

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

CONNECTIONS_PER_NODE_BULK

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

CONNECTIONS_PER_NODE_REG

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

CONNECTIONS_PER_NODE_STATE

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

CONNECTIONS_PER_NODE_PING

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

TCP_CONNECT_TIMEOUT

public static final Setting<TimeValue> TCP_CONNECT_TIMEOUT

TCP_NO_DELAY

public static final Setting<java.lang.Boolean> TCP_NO_DELAY

TCP_KEEP_ALIVE

public static final Setting<java.lang.Boolean> TCP_KEEP_ALIVE

TCP_REUSE_ADDRESS

public static final Setting<java.lang.Boolean> TCP_REUSE_ADDRESS

TCP_SEND_BUFFER_SIZE

public static final Setting<ByteSizeValue> TCP_SEND_BUFFER_SIZE

TCP_RECEIVE_BUFFER_SIZE

public static final Setting<ByteSizeValue> TCP_RECEIVE_BUFFER_SIZE

TCP_NO_DELAY_PROFILE

public static final Setting.AffixSetting<java.lang.Boolean> TCP_NO_DELAY_PROFILE

TCP_KEEP_ALIVE_PROFILE

public static final Setting.AffixSetting<java.lang.Boolean> TCP_KEEP_ALIVE_PROFILE

TCP_REUSE_ADDRESS_PROFILE

public static final Setting.AffixSetting<java.lang.Boolean> TCP_REUSE_ADDRESS_PROFILE

TCP_SEND_BUFFER_SIZE_PROFILE

public static final Setting.AffixSetting<ByteSizeValue> TCP_SEND_BUFFER_SIZE_PROFILE

TCP_RECEIVE_BUFFER_SIZE_PROFILE

public static final Setting.AffixSetting<ByteSizeValue> TCP_RECEIVE_BUFFER_SIZE_PROFILE

BIND_HOST_PROFILE

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

PUBLISH_HOST_PROFILE

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

PORT_PROFILE

public static final Setting.AffixSetting<java.lang.String> PORT_PROFILE

PUBLISH_PORT_PROFILE

public static final Setting.AffixSetting<java.lang.Integer> PUBLISH_PORT_PROFILE

PING_DATA_SIZE

public static final int PING_DATA_SIZE

See Also:

Constant Field Values

scheduledPing

protected final TcpTransport.ScheduledPing scheduledPing

threadPool

protected final ThreadPool threadPool

networkService

protected final NetworkService networkService

profileSettings

protected final java.util.Set<TcpTransport.ProfileSettings> profileSettings

transportService

protected volatile TransportService transportService

connectedNodes

protected final java.util.concurrent.ConcurrentMap<DiscoveryNode,TcpTransport.NodeChannels> connectedNodes

profileBoundAddresses

protected final java.util.concurrent.ConcurrentMap<java.lang.String,BoundTransportAddress> profileBoundAddresses

connectionLock

protected final KeyedLock<java.lang.String> connectionLock

closeLock

protected final java.util.concurrent.locks.ReadWriteLock closeLock

compress

protected final boolean compress

boundAddress

protected volatile BoundTransportAddress boundAddress

defaultConnectionProfile

protected final ConnectionProfile defaultConnectionProfile

Constructor Detail

TcpTransport

public TcpTransport(java.lang.String transportName,
                    Settings settings,
                    ThreadPool threadPool,
                    BigArrays bigArrays,
                    CircuitBreakerService circuitBreakerService,
                    NamedWriteableRegistry namedWriteableRegistry,
                    NetworkService networkService)

Method Detail

doStart

protected void doStart()

Specified by:

doStart in class AbstractLifecycleComponent

getInFlightRequestBreaker

public CircuitBreaker getInFlightRequestBreaker()

Specified by:

getInFlightRequestBreaker in interface Transport

setTransportService

public void setTransportService(TransportService service)

Specified by:

setTransportService in interface Transport

nodeConnected

public boolean nodeConnected(DiscoveryNode node)

Description copied from interface: Transport

Returns true if the node is connected.

Specified by:

nodeConnected in interface Transport

connectToNode

public void connectToNode(DiscoveryNode node,
                          ConnectionProfile connectionProfile,
                          CheckedBiConsumer<Transport.Connection,ConnectionProfile,java.io.IOException> connectionValidator)
                   throws ConnectTransportException

Description copied from interface: Transport

Connects to a node with the given connection profile. If the node is already connected this method has no effect. Once a successful is established, it can be validated before being exposed.

Specified by:

connectToNode in interface Transport

Throws:

ConnectTransportException

resolveConnectionProfile

protected ConnectionProfile resolveConnectionProfile(ConnectionProfile connectionProfile)

openConnection

public final TcpTransport.NodeChannels openConnection(DiscoveryNode node,
                                                      ConnectionProfile connectionProfile)
                                               throws java.io.IOException

Description copied from interface: Transport

Opens a new connection to the given node and returns it. In contrast to Transport.connectToNode(DiscoveryNode, ConnectionProfile, CheckedBiConsumer) the returned connection is not managed by the transport implementation. This connection must be closed once it's not needed anymore. This connection type can be used to execute a handshake between two nodes before the node will be published via Transport.connectToNode(DiscoveryNode, ConnectionProfile, CheckedBiConsumer).

Specified by:

openConnection in interface Transport

Throws:

java.io.IOException

getConnection

public TcpTransport.NodeChannels getConnection(DiscoveryNode node)

Description copied from interface: Transport

Returns a connection for the given node if the node is connected. Connections returned from this method must not be closed. The lifecycle of this connection is maintained by the Transport implementation.

Specified by:

getConnection in interface Transport

See Also:

Transport.connectToNode(DiscoveryNode, ConnectionProfile, CheckedBiConsumer)

disconnectFromNode

public void disconnectFromNode(DiscoveryNode node)

Description copied from interface: Transport

Disconnected from the given node, if not connected, will do nothing.

Specified by:

disconnectFromNode in interface Transport

getCurrentVersion

protected Version getCurrentVersion()

boundAddress

public BoundTransportAddress boundAddress()

Description copied from interface: Transport

The address the transport is bound on.

Specified by:

boundAddress in interface Transport

profileBoundAddresses

public java.util.Map<java.lang.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

getLocalAddresses

public java.util.List<java.lang.String> getLocalAddresses()

Specified by:

getLocalAddresses in interface Transport

bindServer

protected void bindServer(TcpTransport.ProfileSettings profileSettings)

bindToPort

protected java.net.InetSocketAddress bindToPort(java.lang.String name,
                                                java.net.InetAddress hostAddress,
                                                java.lang.String port)

resolvePublishPort

public static int resolvePublishPort(TcpTransport.ProfileSettings profileSettings,
                                     java.util.List<java.net.InetSocketAddress> boundAddresses,
                                     java.net.InetAddress publishInetAddress)

addressesFromString

public TransportAddress[] addressesFromString(java.lang.String address,
                                              int perAddressLimit)
                                       throws java.net.UnknownHostException

Description copied from interface: Transport

Returns an address from its string representation.

Specified by:

addressesFromString in interface Transport

Throws:

java.net.UnknownHostException

doClose

protected final void doClose()

Specified by:

doClose in class AbstractLifecycleComponent

doStop

protected final void doStop()

Specified by:

doStop in class AbstractLifecycleComponent

onException

protected void onException(TcpChannel channel,
                           java.lang.Exception e)

serverAcceptedChannel

protected void serverAcceptedChannel(TcpChannel channel)

bind

protected abstract TcpChannel bind(java.lang.String name,
                                   java.net.InetSocketAddress address)
                            throws java.io.IOException

Binds to the given InetSocketAddress

Parameters:

name - the profile name

address - the address to bind to

Throws:

java.io.IOException

initiateChannel

protected abstract TcpChannel initiateChannel(DiscoveryNode node,
                                              TimeValue connectTimeout,
                                              ActionListener<java.lang.Void> connectListener)
                                       throws java.io.IOException

Initiate a single tcp socket channel to a node. Implementations do not have to observe the connectTimeout. It is provided for synchronous connection implementations.

Parameters:

node - the node

connectTimeout - the connection timeout

connectListener - listener to be called when connection complete

Returns:

the pending connection

Throws:

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

stopInternal

protected void stopInternal()

Called to tear down internal resources

canCompress

public boolean canCompress(TransportRequest request)

sendErrorResponse

public void sendErrorResponse(Version nodeVersion,
                              TcpChannel channel,
                              java.lang.Exception error,
                              long requestId,
                              java.lang.String action)
                       throws java.io.IOException

Sends back an error response to the caller via the given channel

Parameters:

nodeVersion - the caller node version

channel - the channel to send the response to

error - the error to return

requestId - the request ID this response replies to

action - the action this response replies to

Throws:

java.io.IOException

sendResponse

public void sendResponse(Version nodeVersion,
                         TcpChannel channel,
                         TransportResponse response,
                         long requestId,
                         java.lang.String action,
                         TransportResponseOptions options)
                  throws java.io.IOException

Sends the response to the given channel. This method should be used to send TransportResponse objects back to the caller.

Throws:

java.io.IOException

See Also:

for sending back errors to the caller

validateMessageHeader

public static boolean validateMessageHeader(BytesReference buffer)
                                     throws java.io.IOException

Validates the first N bytes of the message header and returns false if the message is a ping message and has no payload ie. isn't a real user level message.

Throws:

java.lang.IllegalStateException - if the message is too short, less than the header or less that the header plus the message size

TcpTransport.HttpOnTransportException - if the message has no valid header and appears to be a HTTP message

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

java.io.IOException

messageReceived

public final void messageReceived(BytesReference reference,
                                  TcpChannel channel,
                                  java.lang.String profileName,
                                  java.net.InetSocketAddress remoteAddress,
                                  int messageLengthBytes)
                           throws java.io.IOException

This method handles the message receive part for both request and responses

Throws:

java.io.IOException

handleRequest

protected java.lang.String handleRequest(TcpChannel channel,
                                         java.lang.String profileName,
                                         StreamInput stream,
                                         long requestId,
                                         int messageLengthBytes,
                                         Version version,
                                         java.net.InetSocketAddress remoteAddress,
                                         byte status)
                                  throws java.io.IOException

Throws:

java.io.IOException

validateRequest

protected void validateRequest(StreamInput stream,
                               long requestId,
                               java.lang.String action)
                        throws java.io.IOException

Throws:

java.io.IOException

executeHandshake

protected Version executeHandshake(DiscoveryNode node,
                                   TcpChannel channel,
                                   TimeValue timeout)
                            throws java.io.IOException,
                                   java.lang.InterruptedException

Throws:

java.io.IOException

java.lang.InterruptedException

newRequestId

public long newRequestId()

Description copied from interface: Transport

Returns a new request ID to use when sending a message via Transport.Connection.sendRequest(long, String, TransportRequest, TransportRequestOptions)

Specified by:

newRequestId in interface Transport

ensureOpen

protected final void ensureOpen()

Ensures this transport is still started / open

Throws:

java.lang.IllegalStateException - if the transport is not started / open

getNumOpenServerConnections

protected abstract long getNumOpenServerConnections()

Returns count of currently open connections

getStats

public final TransportStats getStats()

Specified by:

getStats in interface Transport

getProfileSettings

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

Returns all profile settings for the given settings object