org.elasticsearch.transport.local

Class LocalTransport

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.common.component.AbstractLifecycleComponent

org.elasticsearch.transport.local.LocalTransport

All Implemented Interfaces:

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

public class LocalTransport
extends AbstractLifecycleComponent
implements Transport

Nested Class Summary

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

Transport.Connection

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LOCAL_TRANSPORT_THREAD_NAME_PREFIX
protected NamedWriteableRegistry	namedWriteableRegistry
static java.lang.String	TRANSPORT_LOCAL_ADDRESS
static java.lang.String	TRANSPORT_LOCAL_QUEUE
static java.lang.String	TRANSPORT_LOCAL_WORKERS

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
LocalTransport(Settings settings, ThreadPool threadPool, NamedWriteableRegistry namedWriteableRegistry, CircuitBreakerService circuitBreakerService)

Method Summary

Modifier and Type	Method and Description
TransportAddress[]	addressesFromString(java.lang.String address, int perAddressLimit) Returns an address from its string representation.
boolean	addressSupported(java.lang.Class<? extends TransportAddress> address) Is the address type supported.
BoundTransportAddress	boundAddress() The address the transport is bound on.
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()
Transport.Connection	getConnection(DiscoveryNode node) Returns a connection for the given node if the node is connected.
java.util.List<java.lang.String>	getLocalAddresses()
protected Version	getVersion()
protected void	handleParsedResponse(TransportResponse response, TransportResponseHandler handler)
protected void	handleResponse(StreamInput buffer, LocalTransport sourceTransport, TransportResponseHandler handler)
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.
Transport.Connection	openConnection(DiscoveryNode node, ConnectionProfile profile) Opens a new connection to the given node and returns it.
protected void	processReceivedMessage(byte[] data, java.lang.String action, LocalTransport sourceTransport, Version version, java.lang.Long sendRequestId) processes received messages, assuming thread passing and thread context have all been dealt with
java.util.Map<java.lang.String,BoundTransportAddress>	profileBoundAddresses() Further profile bound addresses
void	receiveMessage(Version version, byte[] data, java.lang.String action, java.lang.Long requestId, LocalTransport sourceTransport) entry point for incoming messages
protected void	sendRequest(LocalTransport targetTransport, DiscoveryNode node, long requestId, java.lang.String action, TransportRequest request, TransportRequestOptions options)
long	serverOpen() Returns count of currently open connections
void	transportServiceAdapter(TransportServiceAdapter transportServiceAdapter)

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.transport.Transport

getInFlightRequestBreaker

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

LOCAL_TRANSPORT_THREAD_NAME_PREFIX

public static final java.lang.String LOCAL_TRANSPORT_THREAD_NAME_PREFIX

See Also:

Constant Field Values

namedWriteableRegistry

protected final NamedWriteableRegistry namedWriteableRegistry

TRANSPORT_LOCAL_ADDRESS

public static final java.lang.String TRANSPORT_LOCAL_ADDRESS

See Also:

Constant Field Values

TRANSPORT_LOCAL_WORKERS

public static final java.lang.String TRANSPORT_LOCAL_WORKERS

See Also:

Constant Field Values

TRANSPORT_LOCAL_QUEUE

public static final java.lang.String TRANSPORT_LOCAL_QUEUE

See Also:

Constant Field Values

Constructor Detail

LocalTransport

public LocalTransport(Settings settings,
                      ThreadPool threadPool,
                      NamedWriteableRegistry namedWriteableRegistry,
                      CircuitBreakerService circuitBreakerService)

Method Detail

addressesFromString

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

Description copied from interface: Transport

Returns an address from its string representation.

Specified by:

addressesFromString in interface Transport

addressSupported

public boolean addressSupported(java.lang.Class<? extends TransportAddress> address)

Description copied from interface: Transport

Is the address type supported.

Specified by:

addressSupported in interface Transport

doStart

protected void doStart()

Specified by:

doStart in class AbstractLifecycleComponent

doStop

protected void doStop()

Specified by:

doStop in class AbstractLifecycleComponent

doClose

protected void doClose()

Specified by:

doClose in class AbstractLifecycleComponent

transportServiceAdapter

public void transportServiceAdapter(TransportServiceAdapter transportServiceAdapter)

Specified by:

transportServiceAdapter 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 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

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

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

serverOpen

public long serverOpen()

Description copied from interface: Transport

Returns count of currently open connections

Specified by:

serverOpen in interface Transport

getConnection

public Transport.Connection 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 lifecylce of this connection is maintained by the Transport implementation.

Specified by:

getConnection in interface Transport

See Also:

Transport.connectToNode(DiscoveryNode, ConnectionProfile, CheckedBiConsumer)

openConnection

public Transport.Connection openConnection(DiscoveryNode node,
                                           ConnectionProfile profile)
                                    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

sendRequest

protected void sendRequest(LocalTransport targetTransport,
                           DiscoveryNode node,
                           long requestId,
                           java.lang.String action,
                           TransportRequest request,
                           TransportRequestOptions options)
                    throws java.io.IOException,
                           TransportException

Throws:

java.io.IOException

TransportException

receiveMessage

public void receiveMessage(Version version,
                           byte[] data,
                           java.lang.String action,
                           @Nullable
                           java.lang.Long requestId,
                           LocalTransport sourceTransport)

entry point for incoming messages

Parameters:

version - the version used to serialize the message

data - message data

action - the action associated with this message (only used for error handling when data is not parsable)

requestId - requestId if the message is request (only used for error handling when data is not parsable)

sourceTransport - the source transport to respond to.

processReceivedMessage

protected void processReceivedMessage(byte[] data,
                                      java.lang.String action,
                                      LocalTransport sourceTransport,
                                      Version version,
                                      @Nullable
                                      java.lang.Long sendRequestId)

processes received messages, assuming thread passing and thread context have all been dealt with

handleResponse

protected void handleResponse(StreamInput buffer,
                              LocalTransport sourceTransport,
                              TransportResponseHandler handler)

handleParsedResponse

protected void handleParsedResponse(TransportResponse response,
                                    TransportResponseHandler handler)

getLocalAddresses

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

Specified by:

getLocalAddresses in interface Transport

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

getVersion

protected Version getVersion()